Querying Resources of a Specified Dimension and a Specified Service Type in a Resource Group

Function

This API is used to query resources of a specified dimension for a specified resource type in 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:getServiceResources

Read

-

g:EnterpriseProjectId

ces:resourceGroups:get

-

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

URI

GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources

**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
service	Yes	String	Definition Service type, for example, SYS.ECS. Constraints N/A Range The value is in the service.item format. The values of service and item must be a string, starting with a letter and containing only letters, digits, and underscores (_). The value can contain 3 to 32 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Pagination offset. Constraints N/A Range An integer ranging from 0 to 10,000. Default Value 0
limit	No	String	Definition Number of records displayed on each page. Constraints N/A Range 1 to 100. Default Value N/A
dim_name	No	String	Definition Resource dimension. Constraints N/A Range A dimension allows up to 32 characters and can contain only letters, digits, and these characters: _-#/(). Use commas (,) to separate multiple dimensions. The value can contain 1 to 131 characters. Default Value N/A
status	No	String	Definition Status of alarms to filter. Constraints N/A Range The value can be: health: resources that have alarm rules set but do not trigger alarms. unhealthy: resources that have alarm rules set and trigger alarms. no_alarm_rule: resources that do not have alarm rules set. Default Value N/A
dim_value	No	String	Definition Resource dimension value. Fuzzy match is not supported. If a resource has multiple dimensions, you can specify one of them. Constraints N/A Range 1 to 1,027 characters. Default Value N/A
tag	No	String	Definition Resource tag information. The format is "[key]":"[value]", for example: "ssss":"1111". Constraints N/A Range 0 to 500 characters. Default Value N/A
extend_relation_id	No	String	Definition Enterprise project ID. Constraints N/A Range The value allows 1 to 128 characters and can contain only letters, digits, and hyphens (-). Default Value N/A
product_name	No	String	Definition Name of the cloud product that the resource belongs to. Generally, the value format is Service namespace,First-level dimension of the service, for example, SYS.ECS,instance_id. Constraints N/A Range 0 to 128 characters. Default Value N/A
resource_name	No	String	Definition Resource name. Constraints N/A Range 1 to 128 characters. Default Value N/A
event_status	No	String	Definition Filters events by alarm status. Constraints N/A Range The value can be: health: resources that have event alarm rules set but do not trigger event alarms. unhealthy: resources that have event alarm rules set and trigger event alarms. no_alarm_rule: resources that do not have event alarm rules set. Default Value N/A

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
count	Integer	Definition Total number of resources. Range 0–10,000
resources	Array of GetResourceGroupResources objects	Resources in a resource group.

**Table 5** GetResourceGroupResources
Parameter	Type	Description
status	String	Definition Filters events by alarm 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.
dimensions	Array of ResourceDimension objects	Resource dimension information.
tags	String	Definition Resource tag information. The value is a JSON string in the format of key/value, for example, "{"sss":"aaa"}". Range The value can be: 0 to 10,240 characters.
enterprise_project_id	String	Definition Enterprise project ID. Range The value allows 1 to 128 characters and can contain only letters, digits, and hyphens (-).
event_status	String	Definition Filters events by alarm 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_name	String	Definition Resource name. Range 0 to 128 characters.

**Table 6** ResourceDimension
Parameter	Type	Description
name	String	Definition Dimension of a resource. For example, the dimension of an ECS is instance_id . For details about the dimension names of each resource, see their service documentation. You can navigate there from Services Interconnected with Cloud Eye. Constraints N/A Range The value starts with a letter and allows 1 to 32 characters. It can contain only letters, digits, underscores (_), and hyphens (-). Default Value N/A
value	String	Definition Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Constraints N/A Range 1 to 256 characters Default Value N/A

Status code: 400

**Table 7** 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 8** 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 9** 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 10** 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 11** 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 resources of a specified dimension for a specified resource type in a resource group.

'/v2/{project_id}/resource-groups/{group_id}/services/{service}/resources'

Example Responses

Status code: 200

{
  "count" : 1000,
  "resources" : [ {
    "status" : "health",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
    } ]
  } ]
}