Querying Resources of a Specific Type
Function
This API is used to query resources. To call this API, you must have the rms:resources:list permission. If you need to query ECSs (ecs.cloudservers), set the provider to ecs, and type to cloudservers for the request. For details about the cloud services (provider) and resource types (type), see the Supported Services and Resource Types section in the appendix.
Calling Method
For details, see Calling APIs.
URI
GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies the account ID. Maximum: 36 |
provider |
Yes |
String |
Specifies the cloud service name. Maximum: 20 |
type |
Yes |
String |
Specifies the resource type. Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
region_id |
No |
String |
Specifies the region ID. Maximum: 36 |
ep_id |
No |
String |
Specifies the enterprise project ID. Maximum: 36 |
tag |
No |
Map<String,String> |
Specifies the tag. |
limit |
No |
Integer |
Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200 |
marker |
No |
String |
Specifies the pagination parameter. You can use the marker value in a subsequent call to request the next set of list items. Minimum: 4 Maximum: 400 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Specifies the invoker's token. |
X-Security-Token |
No |
String |
Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resources |
Array of ResourceEntity objects |
Specifies the resource list. |
page_info |
PageInfo object |
Specifies the pagination object. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the resource ID. |
name |
String |
Specifies the resource name. |
provider |
String |
Specifies the cloud service name. |
type |
String |
Specifies the resource type. |
region_id |
String |
Specifies the region ID. |
project_id |
String |
Specifies the project ID in IaaS OpenStack. |
project_name |
String |
Specifies the project name in IaaS OpenStack. |
ep_id |
String |
Specifies the enterprise project ID. |
ep_name |
String |
Specifies the name of an enterprise project. |
checksum |
String |
Specifies the resource checksum. |
created |
String |
Specifies the time when the resource was created. |
updated |
String |
Specifies the time when the resource was updated. |
provisioning_state |
String |
Specifies the status of a resource operation. Enumeration values include Succeeded, Failed, Canceled, and Processing. |
tags |
Map<String,String> |
Specifies the resource tag. |
properties |
Map<String,Object> |
Specifies the detailed properties of the resource. |
state |
String |
Specifies the resource state. Possible values include Normal and Deleted. |
Parameter |
Type |
Description |
---|---|---|
current_count |
Integer |
Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200 |
next_marker |
String |
Specifies the marker value of the next page. Minimum: 4 Maximum: 400 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
Querying all ECSs in current account
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources
Example Responses
Status code: 200
Operation succeeded.
{ "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 Sample Code
The SDK sample code is as follows.
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 |
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.withProvider("{provider}"); request.withType("{type}"); 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 |
# 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.provider = "{provider}" request.type = "{type}" 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 |
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{} request.Provider = "{provider}" request.Type = "{type}" response, err := client.ListResources(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Operation succeeded. |
400 |
Invalid parameters. |
403 |
User authentication failed. |
500 |
Server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot