Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Obtaining Information About a Single Instance Node
Updated on 2025-11-24 GMT+08:00

Obtaining Information About a Single Instance Node

Function

This API is used to obtain information about a single instance node.

URI

GET /v3/{project_id}/instance/nodes-info

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

Table 2 Query parameters

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

datastore_type

Yes

String

Explanation:

Database type

Constraints:

N/A

Values:

  • MySQL
  • TaurusDB
  • PostgreSQL
  • Microsoft SQL Server

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

instance_id

String

Explanation:

Instance ID

Values:

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

instance_name

String

Explanation:

Instance name

Values:

N/A

instance_nodes

Array of Table 4 objects

Explanation:

Instance node list

Values:

N/A

Table 4 instance_nodes

Parameter

Type

Description

id

String

Explanation:

Node ID

Values:

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

name

String

Explanation:

Node name

Values:

N/A

role

String

Explanation:

Node role

Values:

N/A

status

String

Explanation:

Node status

Values:

  • normal
  • abnormal

type

String

Explanation:

Node type

Values:

N/A

Example Request

"GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instance/nodes-info?instance_id=5c59fa7d6f09456b947f32922f9aeda1in01&datastore_type=mysql"

Example Response

Status code: 200

Successful request

{
  "instance_id": "5c59fa7d6f09456b947f32922f9aeda1in01",
  "instance_name": "DAS-MYSQL-AT",
  "instance_nodes": [
    {
      "id": "09ab88b8a12340569ac056af284011d9no01",
      "name": "DAS-MYSQL-AT_node0",
      "role": "master",
      "status": "normal",
      "type": "master"
    }
  ]
}

Status Codes

Status Code

Description

200

Successful request

400

Bad request

500

Internal server error

Error Codes

See Error Codes.