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

Querying Details of a Resource Group

Function

This API is used to query details of a resource group.

URI

GET /v2/{project_id}/resource-groups/{group_id}

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

Request Parameters

Table 2 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 3 Response body parameters

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
association_ep_ids	Array of strings	ID of the enterprise project from which resources in the resource group come. This parameter is mandatory when type is set to EPS. Array length: 1 to 10
tags	Array of ResourceGroupTagRelation objects	Associated tag during dynamic tag matching. This parameter must be specified when type is set to TAG. Array length: 1 to 10

Table 4 ResourceGroupTagRelation

Parameter	Type	Description
key	String	Tag key. Minimum: 1 Maximum: 36 Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$
value	String	Tag value. Minimum: 0 Maximum: 43 Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|\.|_|-)*$

Status code: 400

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

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

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 details of a specified resource group

/v2/{project_id}/resource-groups/{group_id}

Example Responses

Status code: 200

OK

{
  "group_name" : "band",
  "type" : "TAG",
  "tags" : [ {
    "key" : "Resource",
    "value" : "VPC"
  }, {
    "key" : "Usage",
    "value" : "Tmp"
  } ],
  "create_time" : "2006-01-02T15:04:05.000Z",
  "group_id" : "rg1761380163308Dxxxxxxxx",
  "enterprise_project_id" : "0"
}

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: Resource Groups