Help Center/ Workspace/ API Reference/ Workspace APIs/ Report Statistics/ Querying Metrics
Updated on 2026-02-10 GMT+08:00
View PDF
Share

Querying Metrics

Function

Queries metrics.

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

    workspace:statistics:getMetric

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/statistics/metrics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

dim

No

String

Metric dimension. A maximum of three dimensions are supported, and the dimensions are numbered from 0 in dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters. Single-dimension: dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d. Multi-dimension: dim.0=key,value&dim.1=key,value.

start_time

Yes

String

Start time (UTC).

end_time

Yes

String

End time (UTC).

metric_names

Yes

Array of strings

Metric name list.

period

No

String

Data period. The value can be DAY (daily) or HOUR (hourly).

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of Metric objects

Response body for querying metrics.
Table 4 Metric

Parameter

Type

Description

metric_name

String

Metric name.

metric_value

Double

Metric value.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Succeeded.

[ {
  "metric_name" : "desktop_state",
  "metric_value" : 10
} ]

Status Codes

Status Code

Description

200

Succeeded.

400

Invalid request from the client.

401

Authentication failed.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Report Statistics