huawei-cloud-api-definitions-RMS 0.1.20240213

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"}},"EpId":{"description":"企业项目ID","in":"query","name":"ep_id","required":false,"schema":{"maxLength":36,"pattern":"[\\w-]+","type":"string"}},"Limit":{"description":"最大的返回数量","in":"query","name":"limit","required":false,"schema":{"default":200,"format":"int32","maximum":200,"minimum":1,"type":"integer"}},"Marker":{"description":"分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页","in":"query","name":"marker","required":false,"schema":{"maxLength":400,"minLength":4,"pattern":"[A-Za-z0-9+/=%\\-_]+","type":"string"}},"Provider":{"description":"云服务名称","in":"path","name":"provider","required":true,"schema":{"maxLength":20,"pattern":"[\\w]+","type":"string"}},"RegionId":{"description":"区域ID","in":"query","name":"region_id","required":false,"schema":{"maxLength":36,"pattern":"[\\w-]+","type":"string"}},"TagMap":{"description":"标签","in":"query","name":"tag","required":false,"schema":{"additionalProperties":{"items":{"maxLength":255,"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*","type":"string"},"maxItems":5,"maxLength":128,"minItems":0,"pattern":"[\\p{L}\\p{Z}\\p{N}_.:=+\\-@]+","type":"array","uniqueItems":true},"maxProperties":5,"minProperties":1,"type":"object"},"style":"deepObject"},"Type":{"description":"资源类型名称","in":"path","name":"type","required":true,"schema":{"maxLength":32,"pattern":"[\\w-]+","type":"string"}}},"schemas":{"ErrorResp":{"description":"异常错误","properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误消息内容","type":"string"}},"type":"object"},"PageInfo":{"description":"分页对象","properties":{"current_count":{"description":"当前页的资源数量","format":"int32","maximum":200,"minimum":0,"type":"integer"},"next_marker":{"description":"下一页的marker","type":"string"}},"type":"object"},"ResourceEntity":{"description":"资源对象","properties":{"checksum":{"description":"资源详情校验码","type":"string"},"created":{"description":"资源创建时间","type":"string"},"ep_id":{"description":"企业项目id","type":"string"},"ep_name":{"description":"企业项目名称","type":"string"},"id":{"description":"资源id","readOnly":true,"type":"string"},"name":{"description":"资源名称","type":"string"},"project_id":{"description":"Openstack中的项目id","type":"string"},"project_name":{"description":"Openstack中的项目名称","type":"string"},"properties":{"additionalProperties":{"description":"资源详细属性","type":"object"},"description":"资源详细属性","type":"object"},"provider":{"description":"云服务名称","type":"string"},"provisioning_state":{"description":"资源操作状态","type":"string"},"region_id":{"description":"区域id","type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"资源Tag","type":"object"},"type":{"description":"资源类型","readOnly":true,"type":"string"},"updated":{"description":"资源更新时间","type":"string"}},"type":"object"},"ResourceListResponse":{"properties":{"page_info":{"$ref":"#/components/schemas/PageInfo"},"resources":{"description":"资源列表","items":{"$ref":"#/components/schemas/ResourceEntity"},"type":"array"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"71684d03de7545d7bdc1ae5caf95614f","host":"rms.myhuaweicloud.com","id":"4ea60067c8c447f68a5fe4c8f915ae4e","info_version":"v1","method":"get","name":"ListResources","parameters":null,"paths":{"/v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources":{"get":{"description":"返回当前租户下特定资源类型的资源,需要当前用户有rms:resources:list权限。比如查询云服务器,对应的RMS资源类型是ecs.cloudservers,其中provider为ecs,type为cloudservers。 RMS支持的服务和资源类型参见[支持的服务和区域](https://console.huaweicloud.com/eps/#/resources/supported)。","operationId":"ListResources","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/DomainId"},{"$ref":"#/components/parameters/Provider"},{"$ref":"#/components/parameters/Type"},{"$ref":"#/components/parameters/RegionId"},{"$ref":"#/components/parameters/EpId"},{"$ref":"#/components/parameters/TagMap"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Marker"}],"responses":{"200":{"content":{"application/json":{"example":{"page_info":{"current_count":2,"next_marker":null},"resources":[{"checksum":"89ca775e88e04b2c200ccbf9e219ad0d7da42e3f446e5c953d443288134eec41","created":"2020-02-21T08:41:05Z","ep_id":"0","ep_name":"default","id":"7ffd8564-d88a-4bc9-ab51-d8b79a57d0e6","name":"vpc-489c","project_id":"059b5e0a2500d5552fa1c00adada8c06","project_name":"cn-north-7","properties":{"cidr":"192.168.0.0/16","status":"OK"},"provider":"vpc","provisioning_state":"Succeeded","region_id":"cn-north-7","tags":{"use":"test"},"type":"vpcs","updated":"2020-02-21T08:41:05Z"},{"checksum":"db2aad42804951c03a724b7501da9b6b4c14d319dd319d76bb7c658f256a37b0","created":"2020-02-24T08:43:05Z","ep_id":"0","ep_name":"default","id":"b63b33b7-f48c-4048-995b-0445d124a445","name":"VPC_TEST3_20200224163856","project_id":"059b5e0a2500d5552fa1c00adada8c06","project_name":"cn-north-7","properties":{"cidr":"192.168.0.0/16","status":"OK"},"provider":"vpc","provisioning_state":"Succeeded","region_id":"cn-north-7","tags":{"use":"test1"},"type":"vpcs","updated":"2020-08-11T11:55:08Z"}]},"schema":{"$ref":"#/components/schemas/ResourceListResponse"}}},"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":[{"PkiTokenAuth":[]}],"summary":"列举指定类型的资源","tags":["Resource"],"x-is-registered":"Y","x-publishpath":"rms_04_0101","x-request-examples-description-1":"查询当前用户下所有虚拟机","x-request-examples-description-2":"查询当前用户下cn-north-4区域下的虚拟机,返回前100条","x-request-examples-url-1":"GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources","x-request-examples-url-2":"GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources?limit=100&region_id=cn-north-4","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"}