Updated on 2025-09-19 GMT+08:00

Querying Performance Monitoring Metrics

Function

This API is used to query performance monitoring metrics.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/metric-data/indicators

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of IndicatorInfo objects

Definition

Performance metric information.

Range

N/A

Table 3 IndicatorInfo

Parameter

Type

Description

indicator_name

String

Definition

Metric name.

Range

N/A

plugin_name

String

Definition

Name of the collection module.

Range

N/A

default_collect_rate

String

Definition

Default collection frequency.

Range

N/A

support_datastore_version

String

Definition

Supported cluster version.

Range

N/A

Example Requests

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/metric-data/indicators

Example Responses

Status code: 200

Performance monitoring metrics queried.

[ {
  "indicator_name" : "cluster.cpu_usage",
  "plugin_name" : "CpuStat",
  "default_collect_rate" : "30",
  "support_datastore_version" : "8.0.0"
} ]

Status Codes

Status Code

Description

200

Performance monitoring metrics queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.