Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Obtaining Metric Data of Instances in Batches
Updated on 2026-08-25 GMT+08:00

Obtaining Metric Data of Instances in Batches

Function

This API is used to obtain metric data of instances in batches.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • 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

    das::showCloudDBAInfo

    Read

    -

    -

    -

    -

URI

POST /v3/{project_id}/instance/query-instance-metric

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

engine_type

Yes

String

Definition

DB engine type

Constraints

N/A

Range

MySQL

Default Value

N/A

infos

Yes

Array of objects in Table 3

Definition

Instance information list

Constraints

N/A

Range

N/A

Default Value

N/A

metric_names

Yes

Arrays of Strings

Definition

Metric name

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 instance_info

Parameter

Mandatory

Type

Description

instance_id

Yes

Definition

Instance ID

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Long

Definition

Number of diagnosis reports

Range

N/A

health_report_task_list

Array of objects in Table 4

Definition

Diagnosis reports

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instance/query-instance-metric 
 
{
    "engine_type": "mysql",
    "infos": [       
        {
            "instance_id": "a85e88ccd82d48828eefb112076d3a92in01"
        }
    ],
    "metric_names": [
        "qps",
        "tps",
        "mem_usage",
        "cpu_usage",
        "connection_total_count",
        "connection_active_count"
    ]
}

Example Responses

Status code: 200

Success.

{
    "das_metric_infos": [
        {
            "instance_id": "a85e88ccd82d48828eefb112076d3a92in01",
            "threshold_index": 0,
            "instance_status": "ACTIVE",
            "timestamp": 1764057930000,
            "metrics": {
                "mem_usage": 54.3,
                "qps": 4.45,
                "tps": 0,
                "connection_total_count": 16,
                "cpu_usage": 14.68,
                "connection_active_count": 1
            },
            "threshold_metrics": {}
        }
    ]
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.