DescribeRdsList

更新时间:
复制 MD 格式

Queries ApsaraDB RDS for MySQL instances that are used by a PolarDB-X database.

Request parameters

ParameterTypeRequiredDescription
ActionStringYesThe operation that you want to perform. Set the value to DescribeRdsList.
DrdsInstanceIdStringYesThe ID of the PolarDB-X instance.
DbNameStringYesThe name of the database.

Response parameters

ParameterTypeDescription
DataList<RdsInstance>The array that contains the details about each ApsaraDB RDS for MySQL instance.

Parameters returned for each ApsaraDB RDS for MySQL instance

ParameterTypeDescription
InstanceIdIntegerThe ID of the ApsaraDB RDS for MySQL instance.
InstanceNameStringThe ApsaraDB RDS for MySQL instance name that is displayed in the PolarDB-X console.
ConnectUrlStringThe URL used by the PolarDB-X database to connect to the ApsaraDB RDS for MySQL instance.
PortIntegerThe port number.
InstanceStatusStringThe status of the ApsaraDB RDS for MySQL instance. Valid values: 0, 1, 3, and 5 to 15. The value 0 indicates that the instance is being created. The value 1 indicates that the instance is running. The value 3 indicates that the instance is being deleted. The value 5 indicates that the instance is being restarted. The value 6 indicates that the configuration of the instance is being updated. The value 7 indicates that the instance is being restored. The value 8 indicates that the network over which the instance is connected is being switched between an internal network and the Internet. The value 9 indicates that the databases deployed in the instance are being migrated. The value 10 indicates that the instance version is being updated to a later version. The value 11 indicates that the data of the instance is migrated to other ApsaraDB RDS for MySQL instances. The value 12 indicates that the instance is being replicated to create a disaster recovery instance. The value 13 indicates that data is being imported to the instance. The data that is being imported is not from other ApsaraDB RDS for MySQL instances. The value 14 indicates that data from other ApsaraDB RDS for MySQL instances is being imported to the instance. The value 15 indicates that a failover is being performed on the instance.
DbTypeStringThe database type. Valid value: MySQL.
ReadWeightIntegerThe read weight.
ReadOnlyChildList<Child>The array that contains the details about each read-only instance associated with the ApsaraDB RDS for MySQL instance. Each read-only instance has the same properties as the ApsaraDB RDS for MySQL instance, excluding the ReadOnlyChildren attribute.

Error codes

Error codeError messageDescriptionHTTP status code
InvalidDrdsInstanceId.NotFoundThe DrdsInstanceId provided does not exist in our records.The error message returned because the instance does not exist. 404
InvalidDbName.NotFoundThe Drds DbName provided does not exist in our records.The error message returned because the database does not exist. 404
InvalidParameter.MismatchThe specified parameter does not match.The error message returned because one or more parameters are invalid. 400