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.
group_id	Yes	String	Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group_name	String	Resource group name.
group_id	String	Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.
create_time	String	Time when a resource group was created.
enterprise_project_id	String	ID of the enterprise project that a resource group belongs to.
type	String	Resource adding/matching mode. The value can only be EPS (matching enterprise projects), TAG (matching tags), NAME (matching instance names), COMB (combination matching), or Manual (manual adding).
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.
tags	Array of ResourceGroupTagRelation objects	Specified tag rule when the resource matching rule is tag matching.
instances	Array of Instance objects	Parameter transferred for matching resources by instance name.
comb_relation	CombRelation object	Definition Matching resources by combined conditions. Constraints N/A
related_ep_ids	Array of strings	List of specified enterprise projects when the resource matching rule is enterprise project matching.
enterprise_project_id_and_tags	Array of EnterpriseProjectIdAndTags objects	Parameter for matching resources by enterprise project or tag.
status	String	Metric alarm status. The value can be health (alarming), unhealthy (triggered), or no_alarm_rule (no alarm rule is set).
event_status	String	Event alarm status. The value can be health (alarming), unhealthy (triggered), or no_alarm_rule (no alarm rule is set).
resource_statistics	resource_statistics object	Resource quantity statistics.
resource_level	String	dimension indicates the sub-dimension, and product indicates the cloud product.
product_names	String	Value of a cloud product when the resource level is cloud product. Generally, the value consists of the service namespace and the first-level dimension name of the service, for example, SYS.ECS,instance_id. Use semicolons (;) to separate multiple cloud products, for example, "SERVICE.BMS,instance_id;SYS.ECS,instance_id".
ep_resource_statistics	Array of EpResourceStatistics objects	Status of resources associated with each enterprise project

**Table 4** ResourceGroupTagRelation
Parameter	Type	Description
key	String	Definition TMS tag key specifications. Constraints N/A Range [1,128] Default Value N/A
operator	String	Definition Tag operator, which indicates the relationship between the tag key and value. Constraints N/A Range include: include prefix: prefix suffix: suffix notInclude: not included equal: equal. If operator is equal and value is an empty string, all tag values of the key are matched. all: all Default Value N/A
value	String	Definition TMS tag value specifications. Constraints N/A Range [0,255] Default Value N/A

**Table 5** Instance
Parameter	Type	Description
product_name	String	Definition Cloud product name. Constraints N/A Range 1 to 16 characters Default Value N/A
logical_operator	String	Definition Logical operator. Constraints N/A Range ALL: All conditions are matched. ANY: Any condition is matched. Default Value N/A
instance_names	Array of ResourceNameItem objects	Definition Parameter array for matching resources by resource name. Constraints Max. 10 names

**Table 6** ResourceNameItem
Parameter	Type	Description
resource_name	String	Definition Resource name condition value. Constraints N/A Range [0,128] Default Value N/A
operator	String	Definition Instance operator, which indicates the operation relationship between the actual resource name and the resource name condition value. Constraints N/A Range include: include prefix: prefix suffix: suffix notInclude: not included equal: equal all: all Default Value N/A
resource_name_is_ignore_case	Boolean	Definition Resource name (case insensitive). Constraints N/A Range true: case insensitive false: case sensitive Default Value false

**Table 7** CombRelation
Parameter	Type	Description
logical_operator	String	Definition Logical operator. Constraints N/A Range ALL: All conditions are matched. ANY: Any condition is matched. Default Value N/A
conditions	Array of Condition objects	Definition Combined matching conditions for resource groups. Constraints A maximum of 50 conditions are allowed.

**Table 8** Condition
Parameter	Type	Description
enterprise_project_id	String	Definition Enterprise project ID. Constraints N/A Range The value can be 0 (ID of the default enterprise project) or consists of digits, letters, or hyphens (-). Default Value N/A
instance_name	CombResourceName object	Matching resources by resource name.
tag	ResourceGroupTagRelation object	Definition Tag matching rule. Constraints N/A

**Table 9** CombResourceName
Parameter	Type	Description
resource_name	String	Definition Resource name condition value. Constraints N/A Range 1 to 128 characters Default Value N/A
operator	String	Definition Instance operator, which indicates the operation relationship between the actual resource name and the resource name condition value. Constraints N/A Range include: include prefix: prefix suffix: suffix notInclude: not included equal: equal Default Value N/A
resource_name_is_ignore_case	Boolean	Definition Resource name (case insensitive). Constraints N/A Range true: The name is case insensitive. false: The name is case sensitive. Default Value false

**Table 10** EnterpriseProjectIdAndTags
Parameter	Type	Description
enterprise_project_id	String	Definition Enterprise project ID. Constraints N/A Range The value allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-). Default Value N/A
tag	ResourceGroupTagRelation object	Definition Tag matching rule. Constraints N/A

**Table 11** resource_statistics
Parameter	Type	Description
unhealthy	Integer	Number of resources in the alarm
total	Integer	Total number of resources.
event_unhealthy	Integer	Number of triggered resources
namespaces	Integer	Resource Types

**Table 12** EpResourceStatistics
Parameter	Type	Description
extend_relation_id	String	Enterprise project ID
unhealthy	Integer	Number of resources in the alarm
total	Integer	Total number of resources.
event_unhealthy	Integer	Number of triggered resources
namespaces	Integer	Resource Types

Status code: 400

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 401

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 403

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 404

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Status code: 500

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Status codes customized by each cloud service when a request error occurs.
error_msg	String	Request error message.
request_id	String	Request ID.

Example Requests

Query details of a resource group.

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

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	OK
400	Parameter verification failed.
401	Not authenticated.
403	Authentication failed.
404	Resource not found.
500	Internal system error.

Error Codes

See Error Codes.

Parent topic: Resource Groups

Previous topic: Modifying a Resource Group

Next topic: Querying Resource Groups

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.