Querying Details of a Resource Group

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ces:resourceGroups:get

Read

-

g:EnterpriseProjectId

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ces:resourceGroups:get	Read	-	g:EnterpriseProjectId	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters. Default Value N/A
group_id	Yes	String	Definition Resource group ID. Constraints N/A Range The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
group_name	String	Definition Resource group name. Range The value allows 1 to 128 characters. It can only contain letters, digits, hyphens (-), and underscores (_).
group_id	String	Definition Resource group ID. Range The value starts with rg and is followed by 22 characters that can include letters and digits. 2 to 24 characters.
create_time	String	Definition Time when a resource group was created. Range N/A
update_time	String	Definition Time when a resource group was modified. Range N/A
enterprise_project_id	String	Definition ID of the enterprise project that a resource group belongs to. Range The value can contain letters, digits, and hyphens (-). It can be 0 (ID of the default enterprise project).
type	String	Definition Method of adding or matching resources. Range The value can be: EPS: by enterprise project. TAG: by tag. NAME: by instance name. COMB: by multiple criteria. Manual: manual addition.
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	Matching resources by combined conditions.
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	Definition Metric monitoring status. Range The value can be: health: No alarms are generated. unhealthy: An alarm is generated. no_alarm_rule: No alarm rules have been set.
event_status	String	Definition Event monitoring status. Range The value can be: health: No alarms are generated. unhealthy: An alarm is generated. no_alarm_rule: No alarm rules have been set.
resource_statistics	resource_statistics object	Resource quantity statistics.
resource_level	String	Definition Resource level. Range The value can be: product: cloud product. dimension: specific dimension.
product_names	String	Definition Name of a cloud product when the resource level is cloud product. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Multiple cloud products are separated by semicolons (;), for example, SERVICE.BMS,instance_id;SYS.ECS,instance_id. Range 0 to 10,240 characters.
ep_resource_statistics	Array of EpResourceStatistics objects	Status of resources associated with each enterprise project
association_alarm_templates	Array of AssociationAlarmTemplate objects	Associated alarm templates.

**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 0 to 128 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	Definition Number of resources with active alarms. Range 0–9,999,999
total	Integer	Definition Total number of resources. Range 0–9,999,999
event_unhealthy	Integer	Definition Number of resources with active alarms. Range 0–9,999,999
namespaces	Integer	Definition Number of resource types. Range 0–9,999,999

**Table 12** EpResourceStatistics
Parameter	Type	Description
extend_relation_id	String	Definition Enterprise project ID. Range 0 to 64 characters.
unhealthy	Integer	Definition Number of resources with active alarms. Range 0–9,999,999
total	Integer	Definition Total number of resources. Range 0–9,999,999
event_unhealthy	Integer	Definition Number of resources with active alarms. Range 0–9,999,999
namespaces	Integer	Definition Number of resource types. Range 0–9,999,999

**Table 13** AssociationAlarmTemplate
Parameter	Type	Description
template_id	String	Definition Alarm template ID. Range The value starts with at and allows 2 to 64 characters. It can contain only letters and digits.
template_name	String	Definition Alarm template name. Range The value must start with a letter and allows 1 to 128 characters. It can contain only letters, digits, underscores (_), and hyphens (-).

Status code: 400

**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: 401

**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: 403

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

**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.

Status code: 500

**Table 18** 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"
}