Queries the topology of an instance.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5******* |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "None",
"Message": "None",
"RequestId": "7430AB1A-6D49-5B6D-B9E5-920250076074",
"Data": {
"DBInstanceName": "rm-m5ezban**********",
"Connections": [
{
"ZoneId": "cn-qingdao-c",
"DBInstanceName": "rm-m5ezban**********",
"ConnectionString": "rm-m5ezban**********.mysql.rds.aliyuncs.com",
"NetType": "vpc"
}
],
"Nodes": [
{
"DBInstanceName": "rm-m5ezban**********",
"ZoneId": "cn-qingdao-c",
"DedicatedHostId": "i-bpxxxxxxx",
"Role": "master",
"NodeId": "349054",
"DedicatedHostGroupId": "dhg-4n*****"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidAction | Specified action is not valid. | - |
403 | DBInstanceStatusNotActive | The status of the current instance is not active. | The operation failed. Check the status of the RDS instance. |
403 | DBTypeNotSupported | The database type is not supported. | The database engine is not supported. |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | The RDS instance cannot be found. Check the ID or name of the RDS instance. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2022-10-28 | The Error code has changed | View Change Details |
2022-06-13 | Add Operation | View Change Details |