Help Center/ Cloud Eye/ API Reference/ API V2/ Metric Management/ Querying the Original Dimension Values in Server Monitoring

Updated on 2025-10-30 GMT+08:00

View PDF

Querying the Original Dimension Values in Server Monitoring

Function

This API is used to query the original dimension value based on the ECS/BMS resource ID and special dimension value for disks, mount points, processes, GPUs, and RAID controllers. This API is not required for other dimensions.

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:namespacesDimensions:listAgentDimensions	List	-	-	ces:namespacesDimensions:list	-

URI

GET /v2/{project_id}/instances/{instance_id}/agent-dimensions

**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
instance_id	Yes	String	Description Resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755. Constraints: None Value range: The value can contain a maximum of 36 characters. Default value: None

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
dim_name	Yes	String	Description Dimension name. Constraints: None Value range: Enumerated values. The value can be mount_point, disk, proc, gpu, or raid. Default value: None
dim_value	No	String	Description Dimension value. Under the same instance_id, the same dim_value * corresponds to the same original dimension value origin_value, so you do not need to call this API for multiple times. You are advised to combine instance_id and dim_value as the key for data cache and reuse. Constraints: N/A Range: The value can contain a maximum of 32 characters, for example, 2e84018fc8b4484b94e89aae212fe615. Default value: N/A
offset	No	Integer	Description Pagination offset. Constraints: None Value range: The value ranges from 0 to 2147483647. Default value: 0
limit	No	Integer	Description Page size. Constraints: None Value range: The value ranges from 1 to 1000. Default value: 1000

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8.
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
dimensions	Array of AgentDimension objects	Definition: Dimension information.
count	Integer	Definition: Total number of dimensions. Value range: The value is an integer from 0 to 2147483647.

**Table 5** AgentDimension
Parameter	Type	Description
name	String	Definition: Dimension name. Value range: Enumerated values. The value can be mount_point, disk, proc, gpu, or raid.
value	String	Definition: Dimension value. Value range: The value can contain 32 characters.
origin_value	String	Definition: Actual dimension information. Range The value can contain 1 to 1,024 characters.

Status code: 400

**Table 6** 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 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: 500

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

Example Requests

/v2/{project_id}/instances/4270ff17-aba3-4138-89fa-820594c39755/agent-dimensions?offset=0&limit=10

Example Responses

Status code: 200

Query succeeded.

{
  "dimensions" : [ {
    "name" : "disk",
    "value" : "2e84018fc8b4484b94e89aae212fe615",
    "origin_value" : "vda"
  }, {
    "name" : "disk",
    "value" : "6a1b2de69eeb9a037ea23de6b529394d",
    "origin_value" : "vdc"
  } ],
  "count" : 10
}