Help Center/ Data Admin Service/ API Reference/ APIs/ Intelligent O&M/ Exporting the Instance List on the Intelligent O&M Home Page
Updated on 2026-08-25 GMT+08:00

Exporting the Instance List on the Intelligent O&M Home Page

Function

This API is used to export the instance list on the Intelligent O&M home page.

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::listInstances

    Read

    -

    -

    -

    -

URI

POST /v3/{project_id}/instance/export-instance-list

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this 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

N/A

Default Value

N/A

engine_group

Yes

String

Definition

DB engine type

Constraints

N/A

Range

N/A

Default Value

N/A

instance_status

Yes

String

Definition

Instance status

Constraints

N/A

Range

  • normal
  • abnormal
  • metricAbnormal: abnormal metric
  • dataDiskFull: insufficient disk space
  • all

Default Value

N/A

order_value

No

String

Definition

Sorting criteria

Constraints

N/A

Range

N/A

Default Value

N/A

metric_names

No

Arrays of String

Definition

Metric name

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Definition

Total number

Range

N/A

instance_infos

Arrays of Table 4 Objects

Definition

Instance information list

Range

N/A

Table 4 instance_info

Parameter

Type

Description

instance_id

String

Definition

Instance ID

Range

N/A

instance_name

String

Definition

Instance name

Range

N/A

instance_status

String

Definition

Instance status

Range

N/A

metrics

Map

Definition

Metric information

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instance/export-instance-list 
 
{
    "engine_type": "mysql",
    "engine_group": "mysql",
    "instance_status": "all",
    "metric_names": [
        "qps",
        "tps",
        "mem_usage",
        "cpu_usage",
        "connection_total_count",
        "connection_active_count"
    ]
}

Example Responses

Status code: 200

Success.

{
    "instance_infos": [
        {
            "instance_id": "5c59fa7d6f09456b947f32922f9aeda1in01",
            "instance_name": "DAS-MYSQL-AT",
            "instance_status": "ACTIVE",
            "metrics": {
                "mem_usage": 48.2,
                "qps": 3.88,
                "tps": 0,
                "connection_total_count": 16,
                "cpu_usage": 5.07,
                "connection_active_count": 2
            }
        }
    ],
    "total": 1
}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.