Help Center> Config> API Reference> APIs> Resource Query> Listing Resources Recorded by the Resource Recorder

Updated on 2024-05-15 GMT+08:00

View PDF

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"
  }
}