列举指定类型的资源
功能介绍
返回当前用户下特定资源类型的资源,需要当前用户有rms:resources:list权限。比如查询云服务器,对应的资源类型是ecs.cloudservers,其中provider为ecs,type为cloudservers。支持的云服务(provider)和资源类型(type)请参见“附录-支持的服务和资源类型”章节。
调用方法
请参见如何调用API。
URI
GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 最大长度:36 |
provider |
是 |
String |
云服务名称。 最大长度:20 |
type |
是 |
String |
资源类型名称。 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
region_id |
否 |
String |
区域ID。 最大长度:36 |
ep_id |
否 |
String |
企业项目ID。 最大长度:36 |
tag |
否 |
Map<String,String> |
标签。 |
limit |
否 |
Integer |
最大的返回数量。 最小值:1 最大值:200 缺省值:200 |
marker |
否 |
String |
分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 最小长度:4 最大长度:400 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
调用者token。 |
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
Array of ResourceEntity objects |
资源列表。 |
page_info |
PageInfo object |
分页对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
资源ID。 |
name |
String |
资源名称。 |
provider |
String |
云服务名称。 |
type |
String |
资源类型。 |
region_id |
String |
区域ID。 |
project_id |
String |
Openstack中的项目ID。 |
project_name |
String |
Openstack中的项目名称。 |
ep_id |
String |
企业项目ID。 |
ep_name |
String |
企业项目名称。 |
checksum |
String |
资源详情校验码。 |
created |
String |
资源创建时间。 |
updated |
String |
资源更新时间。 |
provisioning_state |
String |
资源操作状态。枚举值:Succeeded(资源操作成功)、Failed(资源操作异常)、Canceled(资源操作取消)、Processing(资源操作正在进行中)。 |
state |
String |
资源状态,保有中(Normal)/已删除(Deleted) |
tags |
Map<String,String> |
资源标签。 |
properties |
Map<String,Object> |
资源详细属性。 |
参数 |
参数类型 |
描述 |
---|---|---|
current_count |
Integer |
当前页的资源数量。 最小值:0 最大值:200 |
next_marker |
String |
下一页的marker。 最小长度:4 最大长度:400 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
请求示例
查询当前用户下所有虚拟机。
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources
响应示例
状态码: 200
操作成功。
{ "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" : "ecs-test-1", "project_id" : "059b5e0a2500d5552fa1c00adada8c06", "project_name" : "project_name", "properties" : { "status" : "ACTIVE" }, "provider" : "ecs", "provisioning_state" : "Succeeded", "region_id" : "regionid1", "tags" : { "use" : "test" }, "type" : "cloudServers", "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" : "ecs-test-2", "project_id" : "059b5e0a2500d5552fa1c00adada8c06", "project_name" : "project_name_1", "properties" : { "status" : "ACTIVE" }, "provider" : "ecs", "provisioning_state" : "Succeeded", "region_id" : "regionid1", "tags" : { "use" : "test1" }, "type" : "cloudServers", "updated" : "2020-08-11T11:55:08Z" } ] }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class ListResourcesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); ListResourcesRequest request = new ListResourcesRequest(); request.withRegionId("<region_id>"); request.withEpId("<ep_id>"); request.withTag("<tag>"); request.withLimit(<limit>); request.withMarker("<marker>"); try { ListResourcesResponse response = client.listResources(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListResourcesRequest() request.region_id = "<region_id>" request.ep_id = "<ep_id>" request.tag = "<tag>" request.limit = <limit> request.marker = "<marker>" response = client.list_resources(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListResourcesRequest{} regionIdRequest:= "<region_id>" request.RegionId = ®ionIdRequest epIdRequest:= "<ep_id>" request.EpId = &epIdRequest tagRequest:= "<tag>" request.Tag = &tagRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListResources(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
输入参数不合法。 |
403 |
用户身份认证失败。 |
500 |
服务器内部错误。 |
错误码
请参见错误码。