You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing instancesDescribeDBInstanceNodes
Copy page
Download PDF
Managing instances
DescribeDBInstanceNodes
Copy page
Download PDF
DescribeDBInstanceNodes

Call the DescribeDBInstanceNodes API to query the detailed information of instance nodes.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-25651c34****
Instance ID.

Response parameters

Name
Type
Example
Description
NodeInfos
Object[]
Please refer to the response example.
Detailed information of instance nodes.
CPUUsedPercentage
Double
0.015
The CPU usage of the node.
LastIOError
String
-
The last IO error of the node, which may be empty.
LastSQLError
String
-
The last SQL error of the node, which may be empty.
MemoryUsedPercentage
Double
0.1727
The memory usage of the node, which may not be returned.
NodeId
String
mysql-25651c34****-md1b4-0
Node ID.
NodeStatus
String
Running

Node status, with the following values:

  • Running: In operation.
  • Creating: In the process of being created.
  • Deleting: In the process of being deleted.
  • Restarting: In the process of restarting.
  • Restoring: In the process of restoration.
  • Updating: In the process of being updated.
  • Upgrading: In the process of being upgraded.
  • Error: Error.
NodeType
String
Primary
The master node needs to pass in Primaryfor NodeType, while the read-only node does not need to pass it in.
SlaveIORunning
Boolean
true
Whether the IO thread of the node is normal. May not be returned.
SlaveSQLRunning
Boolean
true
Whether the SQL thread of the node is normal. May not be returned.
SpaceUsedPercentage
Double
0.042298582457005976
The storage space usage of the node. May not be returned.
SyncDelay
Integer
73
The synchronization delay of the node. Unit: milliseconds.
ZoneId
String
cn-beijing-a
Availability Zone ID.

Sample request 

POST /?Action=DescribeDBInstanceNodes&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "instanceid": "mysql-25651c34****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20250605202902007681F01031C6680603-3c0c42",
        "Action": "DescribeDBInstanceNodes",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "NodeInfos": [
            {
                "CPUUsedPercentage": 0.015,
                "MemoryUsedPercentage": 0.1727,
                "NodeId": "mysql-25651c34****-md1b4-0",
                "NodeStatus": "Running",
                "NodeType": "Primary",
                "SpaceUsedPercentage": 0.042298582457005976,
                "ZoneId": "cn-beijing-a"
            },
            {
                "CPUUsedPercentage": 0,
                "MemoryUsedPercentage": 0.1873,
                "NodeId": "mysql-25651c34****-sf57c-0",
                "NodeStatus": "Running",
                "NodeType": "Secondary",
                "SlaveIORunning": true,
                "SlaveSQLRunning": true,
                "SpaceUsedPercentage": 0.042298582457005976,
                "SyncDelay": 0,
                "ZoneId": "cn-beijing-a"
            },
            {
                "CPUUsedPercentage": 0,
                "MemoryUsedPercentage": 0.1818,
                "NodeId": "mysql-25651c34****-r399d",
                "NodeStatus": "Running",
                "NodeType": "ReadOnly",
                "SlaveIORunning": true,
                "SlaveSQLRunning": true,
                "SpaceUsedPercentage": 0.042298582457005976,
                "SyncDelay": 73,
                "ZoneId": "cn-beijing-a"
            }
        ]
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.08.25 16:17:35