检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 数据可视化展示服务 数据平台和可视化服务 计量话单服务
API概览 ESM提供的符合RESTful API的设计规范的接口,如表 ESM接口说明所示。 表1 ESM接口说明 类型 说明 数据可视化展示服务 查询应用、服务、租户资源等接口。 数据平台和可视化服务 查询、创建、删除API等接口。 计量话单服务 查询、创建话单等接口。
请求body参数 表3 DeleteDataApiRequest对象属性 参数 是否必选 类型 值域 说明 ids 是 string 0~3200个字符 API ID集合,通过逗号隔开 请求示例 POST /rest/gaia/dataapi/v1/api/delete HTTP/1.1
/rest/gaia/dataapi/v1/api 路径参数 无 查询参数 无 请求 请求header参数 表2 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 无 有效的用户Token 请求body参数 表3 CreateDataApiRequest对象属性
是 表7 无 取数逻辑 表5 CreateApi对象属性 参数 是否必选 类型 值域 说明 name 是 string 无 API名称 catalog_id 否 string 无 所属目录id api_path 是 string 无 API path project_id 是 string
如何调用API 构造请求 认证鉴权 返回结果
如何调用API 方案概述 实施步骤
目录总数 表4 ApiVo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 API ID name 否 string 无 API名称 description 否 string 无 API描述 api_path 否 string 无 API URL api_type
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建查询任务接口,您可以从接口的请求部分看到所需的请求参数及参数说明
认证鉴权 ESM调用接口支持Token认证鉴权。 Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Tok
)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于创建查询任务接口,返回如下消息体。 { "job_id": "********" } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg":
计量话单服务 创建查询任务 查询任务状态 查询Job的数据 父主题: API
数据平台和可视化服务 创建API 查询API列表 修改API信息 删除API 获取可视化应用列表 大屏列表 根据Domain id删除所有Domain数据 状态分布 云服务状态数据块 父主题: API
云服务告警查询 硬件告警信息查询 主机指标数据查询 查询服务器性能数据 查询租户云资源 查询ELBv3资源明细 对外租户资源查询 父主题: API
是否必选 类型 值域 说明 id 是 string 无 任务id status 是 string 无 任务状态:success(任务成功,可以查询数据),failure(任务失败),running(任务运行中),pending(任务等待执行) progress 是 int32 无
/rest/dataapi/homs/open-api/v1/DeviceAsset/info HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json X-APIG-Appcode:
状态码 表3 状态码 状态码 说明 201 操作成功。 400 参数错误。 401 token鉴权失败。 403 鉴权失败。 404 rest接口未找到。 500 内部错误。 操作危险级别 Minor 父主题: 计量话单服务
TP50请求时延 200 ms TP99.9请求时延 300 ms 注意事项 无 调用方法 GET URI /rest/dataapi/homs/open-api/v1/CloudServiceAlarm/info 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 cleared
状态码 表3 状态码 状态码 说明 200 操作成功。 400 参数错误。 401 token鉴权失败。 403 鉴权失败。 404 rest接口未找到。 500 内部错误。 操作危险级别 Minor 父主题: 计量话单服务
/rest/dataapi/homs/open-api/v1/host/metricdata HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json X-APIG-Appcode: