检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
云商店开放接口指南 接口使用方法 公共参数 接口列表 公共错误码 APIGW网关错误码 开放接口示例代码 父主题: 联营License客户端软件对接指南
API概览 ESM提供的符合RESTful API的设计规范的接口,如表 ESM接口说明所示。 表1 ESM接口说明 类型 说明 数据可视化展示服务 查询应用、服务、租户资源等接口。 数据平台和可视化服务 查询、创建、删除API等接口。 计量话单服务 查询、创建话单等接口。
云商店开放接口说明 商家发布License授权码商品时,需要先在卖家中心申请测试授权码,然后通过公网调试云商店开放接口。 商家调用激活授权码和授权码心跳检测两个接口成功后,可以在卖家中心查看测试授权码的激活状态和心跳检测状态。 父主题: 云商店开放接口描述
云商店开放接口 接口使用方法 公共参数 接口列表 父主题: SaaS类商品接入指南 V2.0(新商品上架)
/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 构造请求 认证鉴权 返回结果
云商店开放接口描述 云商店开放接口说明 接口使用方法 公共参数 接口兼容性说明 接口列表 测试授权码激活和心跳检测 错误码 父主题: 联营License类授权码商品接入指南(2.0版本)
如何调用API 方案概述 实施步骤
对外API规范 API规范示例 为了对外API在调用时有用户信息,API调用时需要在header中传递Modifier、Creator字段。 值格式为:用户名+空格+用户id,如图1所示。
目录总数 表4 ApiVo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 API ID name 否 string 无 API名称 description 否 string 无 API描述 api_path 否 string 无 API URL api_type
请求body参数 表3 DeleteDataApiRequest对象属性 参数 是否必选 类型 值域 说明 ids 是 string 0~3200个字符 API ID集合,通过逗号隔开 请求示例 POST /rest/gaia/dataapi/v1/api/delete HTTP/1.1
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建查询任务接口,您可以从接口的请求部分看到所需的请求参数及参数说明
获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 POST https://esm-api.cn-south-1
数据平台和可视化服务 创建API 查询API列表 修改API信息 删除API 获取可视化应用列表 大屏列表 根据Domain id删除所有Domain数据 状态分布 云服务状态数据块 父主题: API
云服务告警查询 硬件告警信息查询 主机指标数据查询 查询服务器性能数据 查询租户云资源 查询ELBv3资源明细 对外租户资源查询 父主题: API
4000tps TP50请求时延 2ms TP99.9请求时延 5ms 注意事项 无 调用方法 GET URI /rest/dataapi/homs/open-api/v2/cloudresource/instancedata/{resource_type} 路径参数 参数 是否必选 类型
状态码 表3 状态码 状态码 说明 201 操作成功。 400 参数错误。 401 token鉴权失败。 403 鉴权失败。 404 rest接口未找到。 500 内部错误。 操作危险级别 Minor 父主题: 计量话单服务
计量话单服务 创建查询任务 查询任务状态 查询Job的数据 父主题: API
)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于创建查询任务接口,返回如下消息体。 { "job_id": "********" } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg":
/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 状态码 状态码 说明 200 操作成功。 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
/rest/dataapi/homs/open-api/v1/DeviceAlarm/info HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json X-APIG-Appcode: