doc-exports/docs/ces/api-ref/ListResourceGroupsServicesResources.html

Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group

Function

This API is used to query resources of a specified dimension for a specified resource type in a resource group.

URI

GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources

Table 1 Path parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Minimum: 1 Maximum: 64 Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
group_id	Yes	String	Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both. Minimum: 24 Maximum: 24
service	Yes	String	Service type, for example, SYS.ECS. Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_). Minimum: 3 Maximum: 32

Table 2 Query parameters

Parameter	Mandatory	Type	Description
dim_name	No	String	Resource dimension information. If there are multiple dimensions, they are sorted in alphabetical order and separated by commas (,). This parameter must be used together with namespace. Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-|,)*$
limit	No	String	Number of items on each page during pagination query. The value ranges from 1 to 1000. The default value is 100. Minimum: 1 Maximum: 1000
offset	No	Integer	Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0. Minimum: 0 Maximum: 10000
status	No	String	Resource health status. The value can be: health: An alarm rule has been created for the resource and there is no alarm triggered. unhealthy: An alarm rule has been created for the resource and there are alarms triggered. no_alarm_rule: No alarm rule has been created for the resource.
dim_value	No	String	Resource dimension value. Fuzzy match is not supported. If a resource has multiple dimensions, you can specify one of them. Minimum: 1 Maximum: 256 Regular expression matching: ^([a-z]|[A-Z]|[0-9]|\*|_){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*$
extend_relation_id	No	String	Enterprise project ID. Minimum: 1 Maximum: 128 Regular expression matching: ^([a-z]|[A-Z]|[0-9]|_|-)+$

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
count	Integer	Total number of resources. Minimum: 0 Maximum: 10000
resources	Array of GetResourceGroupResources objects	Resources in a resource group. Array length: 0 to 100

Table 5 GetResourceGroupResources

Parameter	Type	Description
status	String	Resource health status. The value can be: health: An alarm rule has been created for the resource and there is no alarm triggered. unhealthy: An alarm rule has been created for the resource and there are alarms triggered. no_alarm_rule: No alarm rule has been created for the resource.
dimensions	Array of Dimension objects	Resource dimension information. Array length: 1 to 4

Table 6 Dimension

Parameter	Type	Description
name	String	Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions. Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$
value	String	Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Regular expression matching: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$

Status code: 400

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 401

Table 8 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 403

Table 9 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 404

Table 10 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Status code: 500

Table 11 Response body parameters

Parameter	Type	Description
error_code	String	Status code customized by each cloud service when a request error occurs. Minimum: 0 Maximum: 256
error_msg	String	Request error message. Minimum: 0 Maximum: 256
request_id	String	Request ID. Minimum: 0 Maximum: 256

Example Requests

Querying resources of a specified dimension for a specified resource type in a resource group.

/v2/{project_id}/resource-groups/{group_id}/services/{service}/resources

Example Responses

Status code: 200

OK

{
  "count" : 1000,
  "resources" : [ {
    "status" : "health",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Parameter verification failed.
401	Authentication failed.
403	Authentication failed.
404	Resources not found.
500	Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.

Parent topic: Resources in a Resource Group