Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Obtaining Data of a Single Metric on Multiple Nodes
Updated on 2025-11-24 GMT+08:00

Obtaining Data of a Single Metric on Multiple Nodes

Function

This API is used to obtain data of a single metric on multiple nodes.

URI

POST /v3/{project_id}/multi-nodes/single-metric

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

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

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

metric_name

Yes

String

Explanation:

Metric name

Constraints:

N/A

Values:

Table 4

Default value:

N/A

start_at

Yes

Long

Explanation:

Start time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

end_at

Yes

Long

Explanation:

End time

Constraints:

Unix timestamp, in milliseconds

Values:

[0, 2^31-1]. The actual value depends on the query result.

Default value:

N/A

instance_infos

Yes

Array of Table 3 objects

Explanation:

Instance information list

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 3 instance_infos

Parameter

Mandatory

Type

Description

datastore_type

Yes

String

Explanation:

Database type

Constraints:

N/A

Values:

  • MySQL
  • TaurusDB
  • PostgreSQL
  • Microsoft SQL Server

Default value:

N/A

node_infos

Yes

Array of Table 4 objects

Explanation:

Node list

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 4 node_infos

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

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

Default value:

N/A

node_ids

Yes

Array of strings

Explanation:

Node ID list

Constraints:

Multiple values need to be separated by commas (,).

Values:

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

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

metric_name

String

Explanation:

Metric name

Values:

N/A

unit

String

Explanation:

Unit

Values:

N/A

metrics

Array of Table 6 objects

Explanation:

Metric

Values:

N/A

Table 6 metrics

Parameter

Type

Description

instance_id

String

Explanation:

Instance ID

Values:

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

node_id

String

Explanation:

Node ID

Values:

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

series

Array of double

Explanation:

Metric

Values:

N/A

timestamps

Array of long

Explanation:

Timestamp

Values:

N/A

Example Request

"POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/multi-nodes/single-metric"
{
   "metric_name": "mem_usage",
   "start_at": 1736402167049,
   "end_at": 1736403967049,
   "instance_infos": [
       {
           "datastore_type": "mysql",
           "node_infos": [
               {
                   "instance_id": "5c59fa7d6f09456b947f32922f9aeda1in01",
                   "node_ids": [
                       "09ab88b8a12340569ac056af284011d9no01"
                   ]
               }
           ]
       }
   ]
}

Example Response

Status code: 200

Successful request

{  "metric_name": "mem_usage",
  "unit": "%",
  "metrics": [
    {
      "instance_id": "5c59fa7d6f09456b947f32922f9aeda1in01",
      "node_id": "09ab88b8a12340569ac056af284011d9no01",
      "series": [
        54.2,
        54.18,
        54.13,
        54.1,
        54.13,
        54.15,
        54.2,
        54.17,
        54.13,
        54.18,
        54.17,
        54.27,
        54.15,
        54.1,
        54.2,
        54.2,
        54.22,
        54.17,
        54.15,
        54.17,
        54.18,
        54.17,
        54.2,
        54.18,
        54.23,
        54.17,
        54.13,
        54.1
      ],
      "timestamps": [
        1736402220,
        1736402280,
        1736402340,
        1736402400,
        1736402460,
        1736402520,
        1736402580,
        1736402640,
        1736402700,
        1736402760,
        1736402820,
        1736402880,
        1736402940,
        1736403000,
        1736403060,
        1736403120,
        1736403180,
        1736403240,
        1736403300,
        1736403360,
        1736403420,
        1736403480,
        1736403540,
        1736403600,
        1736403660,
        1736403720,
        1736403780,
        1736403840
      ]
    }
  ]
}

Status Codes

Status Code

Description

200

Successful request

400

Bad request

500

Internal server error

Error Codes

See Error Codes.