Queries the details of a custom ApsaraDB RDS for MySQL instance used as the storage of PolarDB-X 1.0.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDrdsDbInstance |
The operation that you want to perform. Set this parameter to DescribeDrdsDbInstance. |
DrdsInstanceId | String | Yes | drdshbga1138**** |
The name of the PolarDB-X 1.0 instance. |
DbName | String | Yes | drds_test |
The name of the database. |
DbInstanceId | String | Yes | rm-bp1t1mk5a5bdj**** |
The ID of the custom ApsaraDB RDS for MySQL instance that you want to query. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Success | Boolean | true |
Indicates whether the request is successful. |
RequestId | String | 4FE09970-CA69-4144-88CA-67FB4BTY56G3 |
The ID of the request. |
DbInstance | Object |
The detailed information about the returned custom ApsaraDB RDS for MySQL instance. |
|
ExpireTime | String | 12341434315 |
The time when the custom ApsaraDB RDS for MySQL instance expires. The value of this parameter is a UNIX timestamp. Unit: seconds. Note This parameter is returned only when the custom ApsaraDB RDS for MySQL instance is
a subscription instance.
|
PayType | String | Postpaid |
The billing method of the custom ApsaraDB RDS for MySQL instance. Valid values:
|
DBInstanceStatus | String | 1 |
The state of the instance. |
NetworkType | String | VPC |
The type of the network. Valid values: VPC. |
Port | Integer | 3306 |
The port used to connect to the custom ApsaraDB RDS for MySQL instance. |
EngineVersion | String | 5.7 |
The engine version of the database that is run on the instance. Valid values: 5.7. |
DmInstanceId | String | dm-************* |
The ID of the resource. |
ConnectUrl | String | rm-***************.mysql.rds.aliyuncs.com |
The URL used to connect to the custom ApsaraDB RDS for MySQL instance. |
ReadWeight | Integer | 70 |
The read ratio of the instance. |
RdsInstType | String | RDS |
The type of the instance. |
RemainDays | String | 0 |
The number of remaining days before the instance expires. |
DBInstanceId | String | rm-*************** |
The ID of the ApsaraDB RDS for MySQL instance. |
DbInstType | String | Primary |
The role of the instance. Valid values:
|
Engine | String | MySQL |
The engine of the database that is run on the instance. Valid value: MySQL. |
ReadOnlyInstances | Array of ReadOnlyInstance |
The list of read-only ApsaraDB RDS for MySQL instances. |
|
ReadOnlyInstance | |||
ExpireTime | String | 1823487328173 |
The timestamp that indicates when the read-only instance expires. |
PayType | String | Postpaid |
The billing method of the read-only instance. |
VersionAction | Integer | 0 |
This parameter is unavailable for read-only instances. |
DBInstanceStatus | String | 1 |
The state of the read-only instance. |
NetworkType | String | VPC |
The network type of the read-only instance. |
Port | Integer | 3306 |
The port used to connect to the read-only instance. |
EngineVersion | String | 5.7 |
The engine version of the database that is run on the read-only instance. |
DmInstanceId | String | dm-************* |
The ID of the resource. |
ConnectUrl | String | rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com |
The URL used to connect to the read-only instance. |
ReadWeight | Integer | 30 |
The read ratio of the read-only instance. |
RdsInstType | String | RDS |
The type of the ApsaraDB RDS for MySQL instance. |
RemainDays | String | 0 |
The number of remaining days before the read-only instance expires. |
DBInstanceId | String | rm-bp1ub71ct9skc**** |
The ID of the read-only instance. |
DbInstType | String | RDS |
The role of the read-only instance. |
Engine | String | MySQL |
The engine of the database that is run on the read-only instance. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeDrdsDbInstance
&DrdsInstanceId=drdshbga1138****
&DbName=drds_test
&DbInstanceId=rm-bp1t1mk5a5bdj****
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDrdsDbInstanceResponse>
<Success>true</Success>
<RequestId>4FE09970-CA69-4144-88CA-67FB4BTY56G3</RequestId>
<DbInstance>
<ExpireTime>12341434315</ExpireTime>
<PayType>Postpaid</PayType>
<DBInstanceStatus>1</DBInstanceStatus>
<NetworkType>VPC</NetworkType>
<Port>3306</Port>
<EngineVersion>5.7</EngineVersion>
<DmInstanceId>dm-*************</DmInstanceId>
<ConnectUrl>rm-***************.mysql.rds.aliyuncs.com</ConnectUrl>
<ReadWeight>70</ReadWeight>
<RdsInstType>RDS</RdsInstType>
<RemainDays>0</RemainDays>
<DBInstanceId>rm-***************</DBInstanceId>
<DbInstType>Primary</DbInstType>
<Engine>MySQL</Engine>
<ReadOnlyInstances>
<ExpireTime>1823487328173</ExpireTime>
<PayType>Postpaid</PayType>
<VersionAction>0</VersionAction>
<DBInstanceStatus>1</DBInstanceStatus>
<NetworkType>VPC</NetworkType>
<Port>3306</Port>
<EngineVersion>5.7</EngineVersion>
<DmInstanceId>dm-*************</DmInstanceId>
<ConnectUrl>rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com</ConnectUrl>
<ReadWeight>30</ReadWeight>
<RdsInstType>RDS</RdsInstType>
<RemainDays>0</RemainDays>
<DBInstanceId>rm-bp1ub71ct9skc****</DBInstanceId>
<DbInstType>RDS</DbInstType>
<Engine>MySQL</Engine>
</ReadOnlyInstances>
</DbInstance>
</DescribeDrdsDbInstanceResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Success" : true,
"RequestId" : "4FE09970-CA69-4144-88CA-67FB4BTY56G3",
"DbInstance" : {
"ExpireTime" : "12341434315",
"PayType" : "Postpaid",
"DBInstanceStatus" : "1",
"NetworkType" : "VPC",
"Port" : 3306,
"EngineVersion" : "5.7",
"DmInstanceId" : "dm-*************",
"ConnectUrl" : "rm-***************.mysql.rds.aliyuncs.com",
"ReadWeight" : 70,
"RdsInstType" : "RDS",
"RemainDays" : "0",
"DBInstanceId" : "rm-***************",
"DbInstType" : "Primary",
"Engine" : "MySQL",
"ReadOnlyInstances" : [ {
"ExpireTime" : "1823487328173",
"PayType" : "Postpaid",
"VersionAction" : 0,
"DBInstanceStatus" : "1",
"NetworkType" : "VPC",
"Port" : 3306,
"EngineVersion" : "5.7",
"DmInstanceId" : "dm-*************",
"ConnectUrl" : "rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com",
"ReadWeight" : 30,
"RdsInstType" : "RDS",
"RemainDays" : "0",
"DBInstanceId" : "rm-bp1ub71ct9skc****",
"DbInstType" : "RDS",
"Engine" : "MySQL"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | The error message returned because an internal error has occurred and the request failed. |
For a list of error codes, visit the API Error Center.