检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 apm2.00000001 Internal error. 内部错误 apm后端服务发生未知异常,请联系apm技术人员进行处理 400
获取项目ID 从控制台获取项目ID 在调用接口的时候,部分URL中需要填入项目编号,所以需要获取到项目编号。项目编号获取步骤如下: 注册并登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID
示例 本节以查询服务列表为例,详细描述接口调用的流程。该示例中的实例是在已部署的SpringCloudDemo服务上,实现调用查询服务列表接口的过程。Spring Cloud是一个基于Spring Boot实现的微服务架构开发工具。它为微服务架构中涉及的配置管理、服务治理、断路器、
获取项目ID 从控制台获取项目ID 在调用接口的时候,部分URL中需要填入项目编号,所以需要获取到项目编号。项目编号获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“基本信息”。 在基本信息页面单击“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题:
调用说明 应用性能管理提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题:
权限策略和授权项 策略和授权项说明 APM授权项
约束与限制 详细的限制请参见具体API的说明。 父主题: 使用前必读
基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用该用户进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员
发起请求 共有两种方式可以基于已构建好的请求消息发起请求,分别为: cURL cURL是一个命令行工具,用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端,发送一个HTTP请求给服务端。可以使用cURL来发起请示,适用于接口调试。 编码 通过编码调用接口,组装请求消息
Token认证 应用场景 当您使用获取用户Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 本节介绍如何调用接口完成Token认证。如何获取Token值,请参考“获取用户Token”。 调用接口步骤 发送
接口调用流程 在调用接口前,首先要获取请求认证,填充至请求消息头中。当前仅支持Token认证。 接口调用的流程为,构造请求消息 > 发起请求消息 > 解析响应消息。 接下来将根据接口调用的流程详细介绍实现的过程及注意的问题。 获取请求认证 构造请求消息 发起请求消息 解析响应消息
APM授权项 此功能目前仅对华北、华东、华南区域开放。 “√”表示支持,“x”表示暂不支持。 表1 API授权项列表 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 查询应用列表 GET /v1/{project_id}
解析响应消息 在接收和解释请求消息后,服务返回一个HTTP响应消息。 响应也是由三个部分组成,分别是:状态行、消息报头、响应正文。 状态行 状态行格式如下: HTTP-Version Status-Code Reason-Phrase CRLF HTTP-Version:表示服务器
公共请求消息头 表1 公共请求消息头 名称 描述 是否必选 示例 X-Auth-Token 用户Token。 使用Token认证时必选 - Content-Type 内容类型。 该字段内容填为“application/json;charset=utf8”。 必选 application
构造请求消息 每一个请求通常由三部分组成,分别是:请求行、请求消息头、请求正文(可选)。 请求行 请求行以一个方法符号开头,以空格分开,后面跟着请求的URI和协议的版本,格式如下: Method Request-URI HTTP-Version CRLF Method:表示请求方法
终端节点 终端节点(Endpoint)即调用API的请求地址,APM2.0不同服务不同区域使用的终端节点相同,即:华北-北京四。 表1 APM 的Endpoint 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4 apm2.cn-north
示例1:查询应用列表 场景描述 本章为查询对应用户下的应用。 涉及其它云服务接口 无。 查询应用列表 接口相关信息 URI格式:GET /v1/apm2/openapi/cmdb/business/get-business-list 请求示例 GET https://{APM_endpoint
策略和授权项说明 如果您需要对您所拥有的APM进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),如果华为云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用APM的其它功能。