检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
方案概述 应用场景 该实践方案提供用户如何进行调用API的操作指导。 方案架构 调用API的操作流程如图 操作流程图所示。 图1 操作流程图 父主题: 如何调用API
参数 是否必选 类型 值域 说明 domain_id 是 string 正则表达式为^[-_0-9a-zA-Z]{0,36}$ ESM服务的租户id。 查询参数 无 请求 请求header参数 请参见请求示例中header描述。 请求body参数 表1 CreateQueryJobRequest对象属性
正则表达式为^[-_0-9a-zA-Z]{0,36}$ 任务id。 domain_id 是 string 正则表达式为^[-_0-9a-zA-Z]{0,36}$ ESM服务的租户id。 查询参数 无 请求 请求header参数 请参见请求示例中header描述。 请求body参数 无 请求示例 GET /mete
查询租户云资源 本版本租户云资源支持种类如下:ECS、BMS、EVS、OBS等华为云租户账号下的基础云服务的资源量查询。 查询ECS资源明细 查询EVS资源明细 查询OBS资源明细 查询BMS资源明细 父主题: 数据可视化展示服务
string 无 归属的OCC项目ID from_project_name 否 string 无 归属的OCC项目名称 template_id 否 string 无 模板ID snapshot_id 否 string 无 快照ID thumbnail 否 string 无 缩略图的地址 created_date
该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于创建查询任务接口,返回如下消息体。 { "job_id": "********" } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 {
查询云服务资源容量 本版本云服务资源容量接口支持如下云服务:ECS-VM、BMS、EVS、OBS、EIP、RDS、DCC、DeH、SFS、VPN等华为云基础云服务的容量查询。 查询ECS虚拟机容量 查询BMS容量 查询EVS容量 查询OBS容量 查询EIP容量 查询RDS容量 查询DCC容量
application/json;charset=UTF8 状态码 表4 状态码 状态码 说明 200 操作成功。 400 参数错误。 403 鉴权失败。 404 接口没找到。 500 默认ServiceException异常码,应用内部错误。 操作危险级别 Minor 父主题: 数据平台和可视化服务
ML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息
string 无 归属的OCC项目ID from_project_name 否 string 无 归属的OCC项目名称 template_id 否 string 无 模板ID snapshot_id 否 string 无 快照ID thumbnail 否 string 无 缩略图的地址 created_date
rset=UTF8 状态码 状态码 说明 200 操作成功。 302 重定向。 400 参数错误。 403 URL鉴权。 404 rest接口没找到。 500 默认ServiceException异常码,应用内部错误。 操作危险级别 Minor 父主题: 数据可视化展示服务
认证鉴权 ESM调用接口支持Token认证鉴权。 Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Toke
application/json;charset=UTF8 状态码 表5 状态码 状态码 说明 200 操作成功。 400 参数错误。 403 鉴权失败。 404 接口没找到。 500 默认ServiceException异常码,应用内部错误。 操作危险级别 Minor 父主题: 数据平台和可视化服务
附录 状态码
application/json;charset=UTF8 状态码 表5 状态码 状态码 说明 200 操作成功。 400 参数错误。 403 鉴权失败。 404 rest接口没找到。 500 默认ServiceException异常码,应用内部错误。 操作危险级别 Minor 父主题: 数据平台和可视化服务
实施步骤 构造请求 认证鉴权 返回结果 父主题: 如何调用API
修订记录 发布日期 修订记录 2024-11-30 第四次正式发布。 2024-07-30 第三次正式发布。 2024-04-30 第二次正式发布。 2023-12-30 第一次正式发布。
状态码 常用状态码请参见表1。 表1 请求状态返回码 状态码 描述 200 OK 201 Created 202 Accepted 204 No Content 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found
大屏所展现的数据如何获取到本地? 可通过对接开放API或大屏所提供的报告导出功能获取相关大屏数据。对接API的具体方法可参见最佳实践中的如何调用API。 父主题: 其他使用相关
支持客户自助开销户,实现客户对云平台的自助管理。 运营管理 对云服务使用配额和计量话单进行管理,让客户实时感知平台整体运行情况、有效实现对平台资源的管控。 全景可视 提供标准数据大屏,可直观监控资源、租户、服务、应用、告警等数据,开放标准API,支持与客户第三方管理平台对接,实现企业数字化运营。