Help Center/ Config/ API Reference/ APIs/ Resource Query/ Listing Resources Recorded by the Resource Recorder
Updated on 2024-06-21 GMT+08:00

Listing Resources Recorded by the Resource Recorder

Function

Querying all resources recorded by the resource recorder. To call this API, you must have the rms:resources:list permission.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

Table 2 Query Parameters

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

type

No

String

Specifies the resource type in the format of provider.type.

Maximum: 40

limit

No

Integer

Specifies the maximum number of resources to return.

Minimum: 1

Maximum: 200

Default: 100

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

id

No

String

Specifies the resource ID.

Maximum: 512

name

No

String

Specifies the resource name.

Maximum: 256

tags

No

Array

Specifies tags. The format is key or key=value.

Array Length: 1 - 5

resource_deleted

No

Boolean

Indicating whether deleted resources need to be returned. This parameter is set to false by default.

Default: false

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Specifies the invoker's token.

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

resources

Array of ResourceEntity objects

Specifies the resource list.

page_info

PageInfo object

Specifies the pagination object.

Table 5 ResourceEntity

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.

state

String

Resource state. The value can be normal or deleted.

tags

Map<String,String>

Specifies the resource tag.

properties

Map<String,Object>

Specifies the detailed properties of the resource.

Table 6 PageInfo

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

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

  • Querying all resources in the current account

    GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources
  • Querying resources in the default enterprise project. 100 records are returned by default.

    GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources?limit=100&ep_id=0

Example Responses

Status code: 200

Operation succeeded.

{
  "resources" : [ {
    "id" : "3ccd9191-6a5e-4939-a971-4652db18b370",
    "name" : "elb-265a",
    "provider" : "elb",
    "type" : "loadbalancers",
    "region_id" : "regionid1",
    "project_id" : "05498e12458025102ff5c0061a584a9f",
    "project_name" : "regionid1_region_service",
    "ep_id" : "0",
    "ep_name" : "default",
    "checksum" : "6e0271b107b764b19acb235f45c0d852f72104fe1d4b32970686e7eae8e87bf4",
    "created" : "2020-02-29T09:39:19Z",
    "updated" : "2020-02-29T09:39:19Z",
    "provisioning_state" : "Succeeded",
    "tags" : { },
    "properties" : {
      "tenant_id" : "05498e12458025102ff5c0061a584a9f",
      "listeners" : [ {
        "id" : "37de3be0-1803-43e2-9bb5-243b4b30b771"
      } ],
      "provisioning_status" : "ACTIVE",
      "description" : "",
      "pools" : [ {
        "id" : "a7ae4e7f-3e97-48ea-bdbc-334684aafac4"
      } ],
      "created_at" : "2020-02-29T09:39:19"
    }
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESJhIkNGEzNWYxMmYtZjM0NC00YTNkLWE1NDEtZWFjMDBiNDIzMjg1GgTGWJss"
  }
}

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
48
49
50
51
52
53
54
55
56
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListTrackedResourcesSolution {

    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();
        ListTrackedResourcesRequest request = new ListTrackedResourcesRequest();
        request.withRegionId("<region_id>");
        request.withEpId("<ep_id>");
        request.withType("<type>");
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withId("<id>");
        request.withName("<name>");
        request.withTags();
        request.withResourceDeleted(<resource_deleted>);
        try {
            ListTrackedResourcesResponse response = client.listTrackedResources(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
36
37
38
39
# 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 = ListTrackedResourcesRequest()
        request.region_id = "<region_id>"
        request.ep_id = "<ep_id>"
        request.type = "<type>"
        request.limit = <limit>
        request.marker = "<marker>"
        request.id = "<id>"
        request.name = "<name>"
        request.tags = 
        request.resource_deleted = <ResourceDeleted>
        response = client.list_tracked_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
46
47
48
49
50
51
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.ListTrackedResourcesRequest{}
	regionIdRequest:= "<region_id>"
	request.RegionId = &regionIdRequest
	epIdRequest:= "<ep_id>"
	request.EpId = &epIdRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	resourceDeletedRequest:= <resource_deleted>
	request.ResourceDeleted = &resourceDeletedRequest
	response, err := client.ListTrackedResources(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 parameter

403

User authentication failed.

500

Server error.

Error Codes

See Error Codes.