El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
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.
URI
GET /v2/{project_id}/resource-groups/{group_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant ID. |
group_id |
Yes |
String |
Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Tenant token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Resource group name. Regex Pattern: ^((([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, 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. Regex Pattern: ^((([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 |
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). Enumeration values:
|
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 multiple criteria. |
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). Enumeration values:
|
event_status |
String |
Event alarm status. The value can be health (alarming), unhealthy (triggered), or no_alarm_rule (no alarm rule is set). Enumeration values:
|
resource_statistics |
resource_statistics object |
Resource quantity statistics. |
resource_level |
String |
dimension indicates the sub-dimension, and product indicates the cloud product. Enumeration values:
|
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 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
TMS tag key specifications. |
operator |
String |
Tag operator, which indicates the relationship between the tag key and value. include: indicates include. prefix: indicates the prefix. suffix: indicates the suffix. notInclude: indicates not included. equal: indicates equal. If operator is equal and value is an empty string, all tag values of the key are matched. all: indicates all. Enumeration values:
|
value |
String |
TMS tag value specifications. |
Parameter |
Type |
Description |
---|---|---|
product_name |
String |
Cloud product name. |
logical_operator |
String |
Logical operator. ALL: All conditions are matched. ANY: Any condition is matched. Enumeration values:
|
instance_names |
Array of ResourceName objects |
Parameter array for matching resources by resource name. |
Parameter |
Type |
Description |
---|---|---|
resource_name |
String |
Resource name condition value. |
operator |
String |
Instance operator, which indicates the operation relationship between the actual resource name and the resource name condition value. include: indicates include. prefix: indicates the prefix. suffix: indicates the suffix. notInclude: indicates not included. equal: indicates equal. all: indicates all. Enumeration values:
|
resource_name_is_ignore_case |
Boolean |
The resource name is case-insensitive. |
Parameter |
Type |
Description |
---|---|---|
logical_operator |
String |
Logical operator. ALL: All conditions are matched. ANY: Any condition is matched. Enumeration values:
|
conditions |
Array of Condition objects |
Combined matching conditions for resource groups. |
Parameter |
Type |
Description |
---|---|---|
enterprise_project_id |
String |
Enterprise Project ID. Regex Pattern: ^((([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)$ |
instance_name |
ResourceName object |
Resource name. |
tag |
ResourceGroupTagRelation object |
Tag matching rule. |
Parameter |
Type |
Description |
---|---|---|
enterprise_project_id |
String |
Enterprise Project ID. Regex Pattern: ^([a-z]|[A-Z]|[0-9]|_|-)+$ |
tag |
ResourceGroupTagRelation object |
Tag matching rule. |
Parameter |
Type |
Description |
---|---|---|
unhealthy |
Integer |
Number of resources in the alarm Value range: 0-9999999 |
total |
Integer |
Total number of resources. Value range: 0-9999999 |
event_unhealthy |
Integer |
Number of triggered resources Value range: 0-9999999 |
namespaces |
Integer |
Resource Types Value range: 0-9999999 |
Parameter |
Type |
Description |
---|---|---|
extend_relation_id |
String |
Enterprise project ID |
unhealthy |
Integer |
Number of resources in the alarm Value range: 0-9999999 |
total |
Integer |
Total number of resources. Value range: 0-9999999 |
event_unhealthy |
Integer |
Number of triggered resources Value range: 0-9999999 |
namespaces |
Integer |
Resource Types Value range: 0-9999999 |
Status code: 400
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
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
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
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
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
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" : "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot