华为云用户手册

请求 请求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项目和企业项目的区别。

请求 请求header参数 请参见请求示例中header描述。 请求body参数 无 请求示例 GET /rest/gaia/dataapi/v1/api/querylist?start=xxx&limit=xxx&name=xxx&full_name=xxx&catalog_id=xxx&catalog_parent_id=xxx&api_status=xxx&api_debug=xxx&start_time=xxx&end_time=xxx&create_user=xxx&sort_key=xxx&sort_dir=xxx&api_path=xxx&request_type=xxx&project_id=xxx HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json

响应 响应参数 响应状态码200：返回ApiListResponse。 表3 ApiListResponse对象属性 参数 是否必选 类型 值域 说明 api_list 否 表4 无 API集合 api_total 否 int32 默认值：0 API总数 catalog_list 否 表5 无 目录集合 catalog_total 否 int32 默认值：0 目录总数 表4 ApiVo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 API ID name 否 string 无 API名称 description 否 string 无 API描述 api_path 否 string 无 API URL api_type 否 string 无 API类型:new（新建API），exist（注册已有API，预留） api_protocol_type 否 string 无 API 协议类型：HTTPS HTTP request_type 否 string 无 API 请求类型，GET,POST create_time 否 int64 无 创建时间 update_time 否 int64 无 更新时间 publish_time 否 int64 无 更新时间 project_id 否 string 无 所属项目 released 否 int32 无 API发布标识 successful_test 否 int32 无 API调试标识 service_type 否 int32 无 单数据源或多数据源 auth_type 否 string 无 认证类型：IAM create_user 否 string 无 创建用户 approve_user_id 否 string 无 审核人 update_user 否 string 无 更新用户 api_status 否 int32 无 状态：1等待发布审批，2发布请求拒绝，3已发布，4下线拒绝，5等待下线审批，8待发布，7发布失败，6下线失败 api_debug 否 int32 无 API调试标识：0等待调试，1调试失败，2调试成功 body 否 string 无 body体(虽然为text，但是长度限制在20480，这个和apig保持一致) retention_period 否 int64 无 API最小保留期,预留 catalog_id 否 string 无 所属目录id security_level 否 string 无 密级 owner_name 否 string 无 owner_name project_name 否 string 无 project_name connection_type 否 string 无 connection_type 表5 ApiCatalogVo对象属性 参数 是否必选 类型 值域 说明 id 否 string 无 ID name 否 string 无 name description 否 string 无 description create_time 否 int64 无 create_time create_user 否 string 无 create_user create_user_id 否 string 无 create_user_id update_time 否 int64 无 update_time update_user 否 string 无 update_user project_id 否 string 无 project_id parent_id 否 string 无 parent_id owner_name 否 string 无 owner_name project_name 否 string 无 project_name 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8

URI /rest/gaia/dataapi/v1/api/querylist 路径参数 无 查询参数 表2 查询参数 参数 是否必选 类型 值域 说明 start 否 integer 0~1000000000 默认值：0 起始页 limit 否 integer 0~1000 默认值：100 分页 name 否 string 0~256个字符 API名称，支持模糊查询 full_name 否 string 0~256个字符 API全名 catalog_id 否 string 0~64个字符 层级ID catalog_parent_id 否 string 0~64个字符 层级父ID api_status 否 string 0~32个字符 标签，支持多选 api_debug 否 string 0~32个字符 状态，支持多选 start_time 否 string 0~32个字符 起始时间范围 end_time 否 string 0~32个字符 结束时间范围 create_user 否 string 0~64个字符 创建人 sort_key 否 string 0~64个字符 排序字段。枚举值：name,create_user。 sort_dir 否 string 0~32个字符 排序方向。枚举值：desc 和asc，默认值：asc。 api_path 否 string 0~512个字符 请求path request_type 否 string 0~32个字符 API 协议类型 project_id 否 string 0~64个字符 项目ID

状态码 常用状态码请参见表1。 表1 请求状态返回码 状态码 描述 200 OK 201 Created 202 Accepted 204 No Content 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 413 Request Entity Too Large 415 Unsupported Media Type 429 Too Many Requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable 父主题： 附录

URI /rest/dataapi/homs/open-api/v1/DeviceAlarm/info 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 cleared 否 string 无 告警是否清除：cleared=0未清除，cleared=1已清除。 service_type 否 string 无 云服务名称：Server/Network。 begin_time 是 string 毫秒时间戳 开始时间。 end_time 是 string 毫秒时间戳 结束时间。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。

请求 请求header参数 参数 是否必选 类型 值域 说明 X-APIG-Appcode 是 string 无 由SRE分配的AppCode。 x-auth-token 是 string 无 调用方APIG的IAM认证token。 x-hcso-domainid 是（H CS O场景） 否（其他场景） string 无 接入的租户ID。 x-hcso-appcode 是 string 无 由SRE分配的AppCode 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/DeviceAlarm/info 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 X-Language 否 string zh-cn en-us 语言信息 请求body参数 无 请求示例 GET /rest/gaia/cloudservicestatus/v1/status/details HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json

响应 响应参数 响应状态码200：返回QueryStatusMahjongResp。 表3 QueryStatusMahjongResp对象属性 参数 是否必选 类型 值域 说明 status 否 表4 无 状态信息 表4 StatusMahjong对象属性 参数 是否必选 类型 值域 说明 regionCode 否 string 无 区域ID regionName 否 string 无 区 域名 称 serviceId 否 string 无 云服务ID serviceName 否 string 无 云服务名称 isDeployed 否 boolean true,false 是否已经部署 emergencyCount 否 int64 无 紧急告警数量 importantCount 否 int64 无 重要告警数量 响应示例 HTTP/1.1 200 OK Date:Wed,19 Jul 2023 14:15:28 GMT Server: example.com Content-Type: application/json;charset=UTF8

请求 请求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/cloudresource/elbv3 HTTP/1.1Host: example.com Content-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": 1, "list": [ { "ms_nodes_list": "", "cluster_name": "", "lb_count": "164", "time_stamp": "1718259970000", "l4_member_capacity": "30000", "l7_member_capacity": "20000", "region_id": "cn-north-7", "type": "ELBv3", "l4_listener_capacity": "10000", "l4_listener_count": "319", "lb_v5_count": "40", "l7_listener_capacity": "5000", "lb_capacity": "8000", "cluster_id": "4951ba23-0eb6-4dd5-92fc-22e94dc75a78", "l4_member_count": "", "l7_member_count": "182", "l7_listener_count": "82", "region_name": "", "cluster_code": "elbv3-cluster01-az1" } ]}

请求 请求header参数 表2 请求header参数 参数 是否必选 类型 值域 说明 X-Auth-Token 是 string 0~5000个字符 有效的用户Token 请求body参数 表3 DeleteDataApiRequest对象属性 参数 是否必选 类型 值域 说明 ids 是 string 0~3200个字符 API ID集合，通过逗号隔开 请求示例 POST /rest/gaia/dataapi/v1/api/delete HTTP/1.1 Host: example.com Content-Type: application/json Accept: application/json

响应 响应参数 响应状态码200：返回QueryJobVo。 表2 QueryJobVo对象属性 参数 是否必选 类型 值域 说明 id 是 string 无 任务id status 是 string 无 任务状态：success（任务成功，可以查询数据），failure（任务失败），running（任务运行中），pending（任务等待执行） progress 是 int32 无 任务进度，0-100表示百分比 响应示例 HTTP/1.1 200 OKDate:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8{ "id": "xxx", "status": "success", "progress": 100}

响应 响应参数 参数 是否必选 类型 值域 说明 code 是 String 无 返回码。 msg 是 String 无 返回消息。 total 是 Integer 无 数据条数。 service_type 否 String 无 云服务名，标识资源所属的云服务DCC。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属的区域类型：DCC_POD租户区用。 total（list内） 否 String 无 可用总量，xx核（CPU单位），xxTB(内存单位)。DCC专属计算集群，池级容量。 allocated 是 String 无 已分配使用量，xx核（CPU单位），xxTB(内存单位)。 metric_type 否 String 无 容量指标（DCC专属计算集群，统计池级容量）CPU、内存。 avaliable 是 String 无 剩余量，xx核（CPU单位），xxTB(内存单位)。 响应示例 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":"dcc", "metric_type":"主机/内存/vCPU", "total":"总数量，单位个/TB/个", "used":"已使用量", "free":"剩余量", "allocated":"已分配量", "available":"可用量", "used_ratio":"使用率", "allocated_ratio":"分配率", "resource_count":"null", "zone_type":"DCC_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 DCC 服务类型。 zone_type 否 string DCC_POD DCC专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=DCC 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 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/DeviceAsset/info 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/v1/CloudServiceAlarm/info 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 cleared 否 string 无 告警是否清除：cleared=0未清除，cleared=1已清除。 service_type 否 string 无 云服务名称：ECS/EVS。 begin_time 是 string 毫秒时间戳 开始时间。 end_time 是 string 毫秒时间戳 结束时间。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。

请求 请求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 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudServiceAlarm/info 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 无 云服务名，标识资源所属的云服务DeH专属主机。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属的区域类型：DeH_POD租户区用。 total（list内） 否 String 无 可用总量，xx台（专属主机/服务器数量单位）。 allocated 是 String 无 已分配使用量，xx台。 metric_type 否 String 无 专属主机规格指标（S数字系列、X系列等）。 avaliable 是 String 无 剩余量，xx台（专属主机/服务器数量单位）。 响应示例 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":"deh", "metric_type":"专属主机规格类型：s3/l5等", "total":"总数量，单位台", "used":"已使用量", "free":"剩余量", "allocated":"可分配量", "available":"可用量", "used_ratio":"使用率", "allocated_ratio":"分配率", "resource_count":"null", "zone_type":"DEH_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 DeH 服务类型。 zone_type 否 string DeH_POD DeH专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=DeH 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

URI /rest/dataapi/homs/open-api/v1/host/performancedata 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 sn 否 string 无 主机sn uuid begin_time 是 long 毫秒时间戳 开始时间 end_time 是 long 毫秒时间戳 结束时间 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{ "total": 5, "list": [ { "dc_code": "WC_WUH_18", "az_code": "cn-north-7", "usage": "mgt|mgt-can", "room_code": "wuhd22", "dates": "2024-01-08", "metric": "CPUUsagePercent", "pack_code": "wuhd22-c-01-7", "model": "2288X V5", "time": "2024-01-08 0:00", "sn": "xxx", "value": "38", "region_code": "cn-north-7", "slot_number": "4" } ] }

请求 请求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/performancedata 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 无 云服务名，标识资源所属的云服务SFS弹性文件服务。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属的区域类型：SFS_POD租户区用。 total（list内） 否 String 无 可用总量，xxTB（弹性文件服务存储容量单位）。 allocated 是 String 无 已分配使用量，xxTB。 metric_type 否 String 无 弹性文件服务规格指标（虚拟存储空间,不体现后端具体规格）。 avaliable 是 String 无 剩余量，xxTB。 响应示例 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":"sfs", "metric_type":"null", "total":"总数量，单位Tb", "used":"已使用量", "free":"剩余量", "allocated":"可分配量", "available":"可用量", "used_ratio":"使用率", "allocated_ratio":"分配率", "resource_count":"null", "zone_type":"SFS_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 SFS 服务类型。 zone_type 否 string SFS_POD SFS专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=SFS 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 无 云服务名，标识资源所属的云服务VPN 虚拟专用网络 。 timestamp 是 Long 无 时间戳。 region 是 String 无 资源所属region中文名。 zone_type 否 String 无 资源所属的区域类型：VPN_POD租户区用。 total（list内） 否 String 无 可用总量，xx条（Connetion线路数），xx个（Gateway网关数）。 allocated 是 String 无 已分配使用量，xx条（Connetion线路数），xx个（Gateway网关数）。 metric_type 否 String 无 VPN服务资源规格容量指标（Connetion线路数；Gateway网关数）。 avaliable 是 String 无 剩余量，xx条（Connetion线路数），xx个（Gateway网关数）。 响应示例 HTTP/1.1 200 OK Date:Tue,18 Jul 2023 09:58:01 GMTServer: example.comContent-Type: application/json;charset=UTF8 { "total": 2, "list": [ { "service_type": "VPN", "total": "0", "available": "0", "metric_type": "connection", "zone_type": "VPN_POD", "used": "0", "free": "0", "used_ratio": "0", "region": "cn-east-264", "resource_count": "0", "allocated": "0", "timestamp": "1650211200000" }, { "service_type": "VPN", "total": "5", "available": "5", "metric_type": "gateway", "zone_type": "VPN_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 VPN 服务类型。 zone_type 否 string VPN_POD VPN专属区。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/CloudService/capacity?service_type=VPN 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 请求body参数 无 请求示例 GET /rest/dataapi/homs/open-api/v1/cloudAuditlog 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

URI /rest/dataapi/homs/open-api/v1/cloudAuditlog 路径参数 无 查询参数 参数 是否必选 类型 值域 描述 log_type 否 string 无 日志类型，0：操作日志，1：安全日志。 begin_time 是 long 毫秒时间戳 开始时间。 end_time 是 long 毫秒时间戳 结束时间。 page_size 是 int 0~1000 页大小。 offset_value 是 int 无 查询起始值。