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

Querying Resource Groups

Function

This API is used to query resource groups.

URI

GET /v2/{project_id}/resource-groups

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

Table 2 Query parameters

Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	ID of the enterprise project that a resource group belongs to. Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$
group_name	No	String	Resource group name. Fuzzy search is supported. Minimum: 1 Maximum: 128 Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$
group_id	No	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
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
limit	No	Integer	Number of items on each page during pagination query. The value ranges from 1 to 100 (default). Minimum: 1 Maximum: 100
type	No	String	Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources). If this parameter is not specified, all resource groups are queried. The value can be: EPS TAG Manual

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 resource groups. Minimum: 0 Maximum: 1000
resource_groups	Array of OneResourceGroupResp objects	Resource group list. Array length: 0 to 100

Table 5 OneResourceGroupResp

Parameter	Type	Description
group_name	String	Resource group name. Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$
group_id	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
create_time	String	Time when the resource group was created. The value is in the 2006-01-02T15:04:05.000Z format.
enterprise_project_id	String	ID of the enterprise project that a resource group belongs to. Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$
type	String	Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources). The value can be: EPS TAG Manual

Status code: 400

Table 6 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 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: 403

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: 500

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

Example Requests

Querying resource groups

/v2/{project_id}/resource-groups?offset=0&limit=100

Example Responses

Status code: 200

OK

{
  "resource_groups" : [ {
    "group_name" : "group1",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg1761380163308Dxxxxxxxx",
    "enterprise_project_id" : "0",
    "type" : "Manual"
  }, {
    "group_name" : "band",
    "type" : "EPS",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg1761380163309Dxxxxxxxx",
    "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02"
  }, {
    "group_name" : "group2",
    "type" : "TAG",
    "create_time" : "2006-01-02T15:04:05.000Z",
    "group_id" : "rg1761380163310Dxxxxxxxx",
    "enterprise_project_id" : "0"
  } ],
  "count" : 3
}

Status Codes

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

Error Codes

See Error Codes.

Parent topic: Resource Groups