华为云用户手册

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的 IAM 认证token。 x-hcso-domainid 否 string 无 接入的租户ID。H CS O场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/TanentCloudResource/InstanceData/ECS HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名，标识资源所属的云服务。BMS裸金属服务。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region 中文名。 zone_type 否 String 无 资源所属区域类型：MANAGE管理区，POD或KVM_POD租户区。 allocated 是 String 无 已分配量，xx台（单位）。 available 是 String 无 剩余量，xx台（单位）。 total(list内) 是 String 无 裸金属服务器可用总量，xx台（单位）。 metric_type 否 String 无 裸金属服务器规格型号指标：如physical.kd1ne.2xlarge型号。 响应示例 HTTP/1.1 200 OK Date:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total": 1, "list": [ { "service_type": "BMS", "total": "4", "available": "4", "metric_type": "physical.kd1ne.2xlarge", "zone_type": "POD", "used": "0", "free": "0", "used_ratio": "0", "region": "cn-east-264", "resource_count": "0", "allocated": "0", "timestamp": "1650211200000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（HCSO场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间（毫秒时间戳）。 end_time 是 int 无 查询结束时间（毫秒时间戳）。 service_type 否 string BMS 服务类型。 zone_type 否 string BMS_POD BMS专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=BMS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名，标识资源所属的云服务RDS云数据库服务。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属区域类型：RDS_POD租户区使用。 total（list内） 否 String 无 可用总量，xx台（单位：实例数）。 allocated 是 String 无 已分配发放量，xx台（单位：实例数）。 avaliable 是 String 无 剩余可发放量，xx台（单位：实例数）。 metric_type 否 String 无 RDS服务指标类型；如：后端为SQLServer关系型DB实例，NoSQLServer非关系DB实例。 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total":33, "list":[ { "service_type":"RDS", "metric_type":"dbtype:sqlServer/nosqlServer", "total":"总数量，单位台", "used":"已使用量", "free":"剩余量", "allocated":"可分配量", "available":"可用量", "used_ratio":"null", "allocated_ratio":"null", "resource_count":"null", "zone_type":"RDS_POD", "timestamp":"时间戳", "region":"cn-north-1" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（HCSO场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间（毫秒时间戳）。 end_time 是 int 无 查询结束时间（毫秒时间戳）。 service_type 否 string RDS 服务类型。 zone_type 否 string RDS_POD RDS专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=RDS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（HCSO场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间（毫秒时间戳）。 end_time 是 int 无 查询结束时间（毫秒时间戳）。 service_type 否 string EVS 服务类型。 zone_type 否 string manage/pod manage管理区，pod租户区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=EVS HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名，标识资源所属的云服务EVS。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属区域类型：MANAGE管理区，POD租户区。 allocated 是 String 无 已分配发放量，xxTB（单位）。 avaliable 是 String 无 剩余可发放量，xxTB（单位）。 metric_type 否 String 无 云硬盘类型指标：如SAS盘，SSD盘、高IO盘、普通IO盘。 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total": 2, "list": [ { "available": "94.5693359375", "metric_type": "SAS", "service_type": "EVS", "zone_type": "MANAGE", "region": "cn-central-229", "allocated": "112.2265625", "timestamp": "1649692800000" }, { "available": "102.4052734375", "metric_type": "SAS", "service_type": "EVS", "zone_type": "MANAGE", "region": "cn-east-264", "allocated": "173.3232421875", "timestamp": "1649692800000" } ] }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（HCSO场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 begin_time 是 int 无 查询开始时间（毫秒时间戳）。 end_time 是 int 无 查询结束时间（毫秒时间戳）。 service_type 否 string ECS_VM 服务类型。 zone_type 否 string manage/pod manage管理区，pod租户区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=ECS_VM HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名，标识资源所属的云服务。ecs-vm为ECS发放的虚拟机。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region 中文名。 zone_type 否 String 无 资源所属区域类型：MANAGE管理区，POD或KVM_POD租户区。 allocated 是 String 无 已分配发放量，xx台（单位）。 avaliable 是 String 无 剩余可发放量，xx台（单位）。 metric_type 否 String 无 虚拟机规格型号指标：如C6-2型号。 响应示例 HTTP/1.1 200 OK Date:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total":33, "list":[ { "service_type":"ecs-vm", "metric_type":"xxx/C6规格", "total":"null", "used":"null", "free":"null", "allocated":"已分配量", "available":"可用量", "used_ratio":"null", "allocated_ratio":"分配率", "resource_count":"null", "zone_type":"管理区manage：租户区pod", "timestamp":"时间戳", "region":"cn-north-1" } ]}

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中“auth.scope”的取值为“project”。 全局级服务需要获取全局级别的Token，此时请求body中“auth.scope”的取值为“domain”。 调用本服务API需要项目级别的Token，即调用“获取用户Token”接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobsContent-Type: application/json X-Auth-Token: ABCDEFJ....

请求 请求header参数 请参见请求示例中header描述。 请求body参数 表1 QueryJobSdrRequest对象属性 参数 是否必选 类型 值域 说明 marker 否 string 正则表达式为^[-_+/=0-9a-zA-Z]{0,200} 默认值："" 查询标记，前次响应中的marker字段；首个查询不需要此字段。 limit 否 int32 1~200 默认值：100 返回的话单数量。 请求示例 GET /meter/v1/{domain_id}/query-jobs/{job_id}/sdr HTTP/1.1Host: example.comContent-Type: application/jsonAccept: application/jsonX-Auth-Token: xxx{ "marker": "xxx", "limit": 10 }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/TanentCloudResource/InstanceData/BMS HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

请求 请求header参数 表2 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 无 有效的用户Token 请求body参数 表3 CreateDataApiRequest对象属性 参数 是否必选 类型 值域 说明 api 是 表4 无 api基本配置 input_param_definition 否 表5 无 入参定义，最大支持50个 data_retrieval_logic 是 表6 无 取数逻辑 表4 CreateApi对象属性 参数 是否必选 类型 值域 说明 name 是 string 无 API名称 catalog_id 否 string 无 所属目录id api_path 是 string 无 API path project_id 是 string 无 所属项目 security_level 是 string 无 密级：open(公开) secret(秘密) top(机密) request_type 是 string 无 API 请求类型，GET,POST description 否 string 无 API描述 表5 CreateInputParamDefine对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 参数名称 para_position 否 string 无 参数位置 query，header，path，body para_type 否 string 无 参数类型 number，string necessary 否 int32 无 是否必填 0（必填），1（不必填） default_value 否 string 无 默认值 example_value 否 string 无 示例值 description 否 string 无 描述 表6 CreateDataRetrievalLogic对象属性 参数 是否必选 类型 值域 说明 connection_type 是 string 无 取数类型:config(配置方式)，script(脚本方式) script_mode 否 表7 无 脚本方式 config_mode 否 表9 无 配置方式 表7 CreateScriptMode对象属性 参数 是否必选 类型 值域 说明 dataconnection_id 是 string 无 数据源 只支持高斯类型或CLICKHOUSE类型 sql_para 是 string 无 取值脚本 total_size_switch 是 int32 无 调试时是否返回totalSize值, 0:不返回totalSize，1:返回totalSize total_size_sql 是 string 无 计算脚本总条数（返回总条数时，该字段有效且必填） pagination 是 int32 无 分页方式： 由数据服务分页 用户在sql中自定义分页逻辑 order_param 否 表8 无 api排序参数，最大支持50个 表8 CreateApiOrderParam对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 变量/参数名称 column_name 否 string 无 字段名称 optional 否 int32 无 是否可选 0:否，1：是 sort_type 否 int32 无 排序方式 0：自定义，1：升序 2：降序 description 否 string 无 描述 order_num 否 int32 无 参数在orderby中的顺序，配置方式生效，1~50 表9 CreateConfigMode对象属性 参数 是否必选 类型 值域 说明 data_asset_id 是 string 无 数据资产id req_param 否 表10 无 请求参数，最大支持50个 resp_param 是 表11 无 api响应参数，最大支持50个 order_param 否 表8 无 api排序参数，最大支持50个 表10 CreateRequestParamMapping对象属性 参数 是否必选 类型 值域 说明 api_para_name 否 string 无 绑定参数 mapping_name 否 string 无 绑定字段 condition_type 否 string 无 操作符 表11 CreateApiResponseParam对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 参数名称 mapping_name 否 string 无 绑定字段 para_type 否 int32 无 参数类型 1：integer，2：string，3：long，4：double example_value 否 string 无 示例值 description 否 string 无 描述 请求示例 POST /rest/gaia/dataapi/v1/api HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json { "api":{ "name":"string", "catalog_id":"string", "api_path":"string", "project_id":"string", "security_level":"string", "request_type":"string", "description":"string" }, "input_param_definition":[ { "para_name":"string", "para_position":"string", "para_type":"string", "necessary":"integer", "default_value":"string", "example_value":"string", "description":"string" } ], "data_retrieval_logic":{ "connection_type":"string", "script_mode":{ "dataconnection_id":"string", "sql_para":"string", "total_size_switch":"integer", "total_size_sql":"string", "pagination":"integer", "order_param":[ { "para_name":"string", "column_name":"string", "optional":"integer", "sort_type":"integer", "description":"string", "order_num":"integer" } ] }, "config_mode":{ "data_asset_id":"string", "req_param":[ { "api_para_name":"string", "mapping_name":"string", "condition_type":"string" } ], "resp_param":[ { "para_name":"string", "mapping_name":"string", "para_type":"integer", "example_value":"string", "description":"string" } ], "order_param":[ { "para_name":"string", "column_name":"string", "optional":"integer", "sort_type":"integer", "description":"string", "order_num":"integer" } ] } } }

URI /rest/mogaiaservice/v1.0/visuals 路径参数 无 查询参数 表2 查询参数 参数 是否必选 类型 值域 说明 type 否 string list card 呈现方式。 list-列表，card-卡片 name 否 string 无 名称 start 否 string 无 起始页 limit 否 string 1000~1 分页 category 否 string report screen 类型，报表-report，大屏-screen managed_status 否 string 0 2 类型，0-创建，2-发布 project_id 否 string 无 归属项目 sort_key 否 string created_date name last_updated_date 排序字段名称，支持的合法取值：created_date, name, last_updated_date sort_order 否 string asc desc 排序顺序，支持的取值：asc（升序）、desc（降序），默认：desc。 is_preset 否 string 0 1 是否预置，预置-1，非预置-0 created_user_name 否 string 无 创建人 catalog_id 否 string 无 所属类型id

请求 请求header参数 请参见请求示例中header描述。 请求body参数 无 请求示例 GET /rest/mogaiaservice/v1.0/visuals?type=xxx&name=xxx&start=xxx&limit=xxx&category=xxx&managed_status=xxx&project_id=xxx&sort_key=xxx&sort_order=xxx&is_preset=xxx&created_user_name=xxx&catalog_id=xxx HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json

响应 响应参数 响应状态码200：返回VisualsListResponse。 表3 VisualsListResponse对象属性 参数 是否必选 类型 值域 说明 Visuals 否 表4 无 项目列表 total 否 integer 无 项目总数 表4 VisualsInfo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 可视化ID name 否 string 无 名称 description 否 string 无 描述 owner 否 string 无 数据Owner category 否 string 无 归属类别, report-报表, screen-大屏 security_level 否 string 无 密级： open-公开 secret-秘密 top-机密 managed_status 否 integer 无 状态 0-创建，1-删除，2-发布 from_project_id 否 string 无 归属的OCC项目ID from_project_name 否 string 无 归属的OCC项目名称 template_id 否 string 无 模板ID snapshot_id 否 string 无 快照ID thumbnail 否 string 无 缩略图的地址 created_date 否 int64 无 创建时间 created_by 否 string 无 创建者 created_user_name 否 string 无 创建者名字 last_updated_date 否 int64 无 最近更新时间 last_updated_by 否 string 无 最近更新者 iam_project_id 否 string 无 IAM中project ID domain_id 否 string 无 domain share 否 string 无 分析ID workspace_id 否 string 无 工作空间ID nav_catalog_id 否 string 无 分类ID nav_catalog_name 否 string 无 分类名称 nav_catalog_name_en 否 string 无 分类英文名称 subscribed_sum 否 int32 默认值：0 已订阅数量 x_language 否 string 无 国际化字段 is_preset 否 int32 默认值：0 是否预置数据 conflict_name 否 string 无 冲突名字 parent_id 否 string 无 父id format 否 integer 无 格式：1-文档，2-幻灯片 scope 否 integer 无 使用域：1-通用，2-专用 manager 否 string 无 管理者（该参数用于存用户id,以“,”方式分隔） published_date 否 int64 无 发布时间 dv_token 否 string 无 dv_token dv_password 否 string 无 dv_password dv_expiration_date 否 string 无 dv_expiration_date dv_is_auth 否 string 无 dv_is_auth dv_type 否 string 无 dv_type dv_snap_shot_id 否 string 无 dv_snap_shot_id dv_current_time 否 int64 无 dv_current_time 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于创建查询任务接口，返回如下消息体。 { "job_id": "********"} 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应 响应参数 响应状态码200：返回QueryStatusOverviewResp。 表3 QueryStatusOverviewResp对象属性 参数 是否必选 类型 值域 说明 highRisk 否 integer 默认值：0 高危状态数量 hiddenTrouble 否 integer 默认值：0 隐患状态数量 healthy 否 integer 默认值：0 健康状态数量 undeployed 否 integer 默认值：0 未部署状态数量 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8

请求 请求header参数 表2 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 无 用户Token X-Language 否 string zh-cn en-us 语言信息 请求body参数 无 请求示例 GET /rest/gaia/cloudservicestatus/v1/status/distribute HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 device_type 否 String 无 物理设备类型，ECS-计算（物理计算服务器），EVS-存储（物理存储服务器）。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属区域类型：MANAGE管理区，POD或KVM_POD租户区。 allocated 是 String 无 已分配量：vCPU单位为Core核，内存为TB，存储为TB。 avaliable 是 String 无 剩余量：vCPU单位为Core核，内存为TB，存储为TB。 resource_type 否 String 无 物理服务器的规格型号，如C6XLarge物理计算服务器，SSD盘的物理存储服务器。 metric_type 否 String 无 容量指标类型：对应device_type物理资源的类型（计算或存储）所不同。 响应示例 HTTP/1.1 200 OK Date:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 存储 { "total": 2, "list": [ { "available": "94.5693359375", "metric_type": "SAS", "device_type": "EVS", "zone_type": "MANAGE", "region": "cn-central-229", "allocated": "112.2265625", "resource_type": "SAS", "timestamp": "1649692800000" }, { "available": "102.4052734375", "metric_type": "SAS", "device_type": "EVS", "zone_type": "MANAGE", "region": "cn-east-264", "allocated": "173.3232421875", "resource_type": "SAS", "timestamp": "1649692800000" } ] } 计算 { "service_type": "ECS", "total": "44.072265625", "available": "26.486328125", "metric_type": "memory", "zone_type": "KVM_POD", "used": "0", "free": "44.072265625", "used_ratio": "0", "region": "cn-east-264", "resource_count": "0", "allocated": "15.2578125", "resource_type": "C6xLarge", "timestamp": "1649865600000" }, { "service_type": "ECS", "total": "10792", "available": "5408", "metric_type": "vCpu", "zone_type": "KVM_POD", "used": "0", "free": "10792", "used_ratio": "0", "region": "cn-east-264", "resource_count": "0", "allocated": "4964", "resource_type": "M6xLarge", "timestamp": "1649865600000" }

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（HCSO场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 查询参数 参数 是否必选 类型 值域 说明 device_type 否 string ECS/EVS 设备类型：ECS-计算（物理计算），EVS-存储（物理存储）。 zone_type 否 string manage/pod manage管理区，pod租户区。 begin_time 是 int 无 查询开始时间（毫秒时间戳）。 end_time 是 int 无 查询结束时间（毫秒时间戳）。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host-physical/capacity HTTP/1.1 Host: example.comContent-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

响应 响应参数 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8{ "total": 12132, "list": [ { "time_stamp": "1697372808000", "monitor_item": "memory", "region_id": "cn-north-xx", "az_name": "", "metrics_name": "Memory", "operator": "AVG", "host_id": "00700188-9859-xxx8-8889-71axxx4565", "az_id": "", "unit": "\\%", "az_name_en": "", "region_name": "", "data_item": "usage", "region_name_en": "", "value": "79.81" } ]}

URI /rest/dataapi/homs/open-api/v1/host/metricdata 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 host_id 是 string 无 主机ID begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 否 integer 无 偏移大小：大于等于0 page_size 否 integer 0~1000 页大小：大于等于0

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/host/metricdata HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

URI /rest/dataapi/homs/open-api/v2/cloudresource/instancedata/{resource_type} 路径参数 参数 是否必选 类型 值域 描述 resource_type 是 string ECS EVS EIP OBS BMS ELB VPN DCS DMS RDS GAUSS MODEL_ARTS_INF MODEL_ARTS_TRAIN MODEL_ARTS_MAOS 资源类型 查询参数 参数 是否必选 类型 值域 描述 begin_time 是 integer 无 开始时间 end_time 是 integer 无 结束时间 offset_value 否 integer 无 偏移大小：大于等于0 page_size 否 integer 0~1000 页大小：大于等于0

响应 响应参数 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8{ "list": [ { "accumulate_factor_name": "Duration", "accumulate_factor_value": "3600", "az_code": "cn-north-213a", "begin_time": "20240301220000", "bp_info": "", "cloud_service_type_code": "hws.service.type.ec2", "csb_params": "::DBSS-9bae:d8c249f201b34a4eb7f739f3471d1532:", "domain_id": "d1803845584b4626850ce57a8a020e4f", "domain_name": "op_svc_dbss_e9f3e8381583492191a9d0c4ba725333", "enterprise_project_id": "", "error_msg": "", "extend_params": "2", "extend_params2": "", "record_type": "20", "region_code": "cn-north-213", "relate_parent_resource": "", "relate_root_resource": "", "resource_id": "f0ae18b6-40d2-4162-9d6a-7697b9b7eacc", "resource_spec_code": "ks1.xlarge.2.linux", "resource_type_code": "hws.resource.type.vm", "site_code": "", "tag": "", "time_stamp": "20240409231657", "project_id": "d1803845584b4626850ce57a8a020emf" } ], "total": 31416}

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v2/cloudresource/instancedata/{resource_type} HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 否 string 无 接入的租户ID。HCSO场景必填，其他场景不要求 x-hcso-appcode 是 string 无 由SRE分配的AppCode。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/TanentCloudResource/InstanceData/OBS HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/jsonX-APIG-Appcode: xxx x-auth-token: xxx x-hcso-domainid：xxx x-hcso-appcode：xxx

请求 请求header参数 表3 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 0~5000个字符 有效的用户Token 请求body参数 表4 CreateDataApiRequest对象属性 参数 是否必选 类型 值域 说明 api 是 表5 无 api基本配置 input_param_definition 否 表6 无 入参定义，最大支持50个 data_retrieval_logic 是 表7 无 取数逻辑 表5 CreateApi对象属性 参数 是否必选 类型 值域 说明 name 是 string 无 API名称 catalog_id 否 string 无 所属目录id api_path 是 string 无 API path project_id 是 string 无 所属项目 security_level 是 string 无 密级：open(公开) secret(秘密) top(机密) request_type 是 string 无 API 请求类型，GET,POST description 否 string 无 API描述 表6 CreateInputParamDefine对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 参数名称 para_position 否 string 无 参数位置 query，header，path，body para_type 否 string 无 参数类型 number，string necessary 否 int32 无 是否必填 0（必填），1（不必填） default_value 否 string 无 默认值 example_value 否 string 无 示例值 description 否 string 无 描述 表7 CreateDataRetrievalLogic对象属性 参数 是否必选 类型 值域 说明 connection_type 是 string 无 取数类型:config(配置方式)，script(脚本方式) script_mode 否 表8 无 脚本方式 config_mode 否 表10 无 配置方式 表8 CreateScriptMode对象属性 参数 是否必选 类型 值域 说明 dataconnection_id 是 string 无 数据源 只支持高斯类型或CLICKHOUSE类型 sql_para 是 string 无 取值脚本 total_size_switch 是 int32 无 调试时是否返回totalSize值, 0:不返回totalSize，1:返回totalSize total_size_sql 是 string 无 计算脚本总条数（返回总条数时，该字段有效且必填） pagination 是 int32 无 分页方式：1 由数据服务分页 2 用户在sql中自定义分页逻辑 order_param 否 表9 无 api排序参数，最大支持50个 表9 CreateApiOrderParam对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 变量/参数名称 column_name 否 string 无 字段名称 optional 否 int32 无 是否可选 0:否，1：是 sort_type 否 int32 无 排序方式 0：自定义，1：升序 2：降序 description 否 string 无 描述 order_num 否 int32 无 参数在orderby中的顺序，配置方式生效，1~50 表10 CreateConfigMode对象属性 参数 是否必选 类型 值域 说明 data_asset_id 是 string 无 数据资产id req_param 否 表11 无 请求参数，最大支持50个 resp_param 是 表12 无 api响应参数，最大支持50个 order_param 否 表9 无 api排序参数，最大支持50个 表11 CreateRequestParamMapping对象属性 参数 是否必选 类型 值域 说明 api_para_name 否 string 无 绑定参数 mapping_name 否 string 无 绑定字段 condition_type 否 string 无 操作符 表12 CreateApiResponseParam对象属性 参数 是否必选 类型 值域 说明 para_name 否 string 无 参数名称 mapping_name 否 string 无 绑定字段 para_type 否 int32 无 参数类型 1：integer，2：string，3：long，4：double example_value 否 string 无 示例值 description 否 string 无 描述 请求示例 PUT /rest/gaia/dataapi/v1/api/{id}/update HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json { "name" : "name", "description" : "xxx", "parent_id":"" }

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 授权范围：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM项目和企业项目的区别。