huawei-cloud-api-definitions-RMS 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":{"parameters":{"AuthToken":{"description":"用户Token。\n获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"schema":{"type":"string"}},"DomainId":{"description":"帐号ID","in":"path","name":"domain_id","required":true,"schema":{"maxLength":36,"pattern":"[\\w-]+","type":"string"}},"EpIdArray":{"description":"企业项目ID列表","explode":false,"in":"query","name":"ep_id","required":false,"schema":{"items":{"maxLength":36,"pattern":"[\\w-]+","type":"string"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"Name":{"description":"资源名称","in":"query","name":"name","required":false,"schema":{"maxLength":512,"pattern":"[^']+","type":"string"}},"ProjectIdArray":{"description":"项目ID","explode":false,"in":"query","name":"project_id","required":false,"schema":{"items":{"maxLength":36,"pattern":"[\\w-]+","type":"string"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"RegionArray":{"description":"区域ID列表","explode":false,"in":"query","name":"region_id","required":false,"schema":{"items":{"maxLength":36,"pattern":"[\\w-]+","type":"string"},"maxItems":10,"minItems":1,"type":"array","uniqueItems":true}},"TagArray":{"description":"标签列表","in":"query","name":"tags","required":false,"schema":{"items":{"description":"标签值, 格式为key或key=value","pattern":"^[\\p{L}\\p{Z}\\p{N}_.:+\\-@]{1,128}(=[\\p{L}\\p{Z}\\p{N}_.:\\/+\\-@]{0,255})?$","type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"TypeArray":{"description":"资源类型(provider.type)","explode":false,"in":"query","name":"type","required":false,"schema":{"items":{"maxLength":40,"pattern":"[\\w.-]+","type":"string"},"maxItems":100,"minItems":1,"type":"array","uniqueItems":true}}},"schemas":{"ErrorResp":{"description":"异常错误","properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误消息内容","type":"string"}},"type":"object"},"ResourceSummaryResponse":{"description":"资源概要信息列表","items":{"$ref":"#/components/schemas/ResourceSummaryResponseItem"},"type":"array"},"ResourceSummaryResponseItem":{"description":"资源概要信息","properties":{"provider":{"description":"云服务名称","type":"string"},"types":{"description":"资源类型列表","items":{"description":"资源类型","properties":{"regions":{"description":"区域列表","items":{"description":"区域概要","properties":{"count":{"description":"该资源类型在当前区域的数量","format":"int64","type":"integer"},"region_id":{"description":"区域id","type":"string"}},"type":"object"},"type":"array"},"type":{"description":"资源类型名称","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"71684d03de7545d7bdc1ae5caf95614f","host":"rms.myhuaweicloud.com","id":"626aa2eeae2b445596724637acb70028","info_version":"v1","method":"get","name":"CollectAllResourcesSummary","parameters":null,"paths":{"/v1/resource-manager/domains/{domain_id}/all-resources/summary":{"get":{"description":"查询当前帐号的资源概览。","operationId":"CollectAllResourcesSummary","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/DomainId"},{"$ref":"#/components/parameters/Name"},{"$ref":"#/components/parameters/TypeArray"},{"$ref":"#/components/parameters/RegionArray"},{"$ref":"#/components/parameters/EpIdArray"},{"$ref":"#/components/parameters/ProjectIdArray"},{"$ref":"#/components/parameters/TagArray"}],"responses":{"200":{"content":{"application/json":{"example":[{"provider":"obs","types":[{"regions":[{"count":5,"region_id":"regionid1"}],"type":"buckets"}]},{"provider":"ecs","types":[{"regions":[{"count":1,"region_id":"regionid2"}],"type":"cloudservers"}]}],"schema":{"$ref":"#/components/schemas/ResourceSummaryResponse"}}},"description":"操作成功。"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}},"description":"输入参数不合法。"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}},"description":"用户认证失败。"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}},"description":"服务器内部错误。"}},"security":[{"AccessKeyAuth":[]}],"summary":"列举资源概要","tags":["Resource"],"x-is-registered":"Y","x-open-region-cloud":"hws,hws_hk","x-publishpath":"rms_04_0108","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/all-resources/summary","x-support-sdk":"Y"}}},"product_short":"RMS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"列举资源概要","tags":"资源清单","uri":null,"version":"3.0.0"}