You can call this operation to retrieve the instance list and obtain the instance details.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstances

The operation that you want to perform. Value: ListInstances .

Tid Long No -1

The ID of the tenant.

Note The tenant ID is taken from the tenant ID displayed when you move the pointer on your profile picture. For more information, see View tenant information .
SearchKey String No test

The keyword to be matched.

DbType String No MySQL

The database engine available.

EnvType String No product

The type of the environment.

InstanceSource String No RDS

The source of the instance.

NetType String No VPC

The network environment of the instance. Valid values: classic network and VPC. For more information, see API of RegisterInstance.

InstanceState String No NORMAL

The status of the database instance. Valid values:

  • NORMAL: The database instance is NORMAL.
  • DISABLE: The database is disabled.
PageNumber Integer No 1

The page number of the returned page.

PageSize Integer No 50

The number of data records on each page. Valid values: 100 to 100.

RegionId String No cn-hangzhou

Region-based API request parameters.

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message of the failure.

InstanceList Array of Instance

The returned list of DRDS instances.

DataLinkName String dblink_test

The name of the data link.

DatabasePassword String ******

The password of the database user.

DatabaseUser String dbUser

The username that is used to log on to the RDS instance.

DbaId String 1

The ID of the database administrator (DBA) of the instance.

DbaNickName String dbaName

The nickname of the DBA.

DdlOnline Integer 1

onlineddl configuration of the instance.

EcsInstanceId String xxx

The ECS ID of the instance.

EcsRegion String cn-hangzhou

The Region of the instance.

EnvType String product


ExportTimeout Integer 600

The timeout period for exporting the data from the database instance.

Host String

The connection address of the instance.

InstanceAlias String test

The alias of the instance.

InstanceId String 1

The instance ID.

InstanceSource String RDS

The source of the instance.

InstanceType String mysql

The database type of the instance.

Port Integer 3306

The instance Port.

QueryTimeout Integer 60

The timeout period for querying the database instance.

SafeRuleId String 1

The ID of the instance security rule.

Sid String test

The system ID (Sid) of the instance.

State String NORMAL

The status of the instance.

UseDsql Integer 1

Indicates whether cross-database query is enabled for the database instance.

VpcId String xxx

The VPC ID of the instance.

RequestId String B4B07137-F6AE-4756-8474-7F92BB6C4E04

The ID of the API request.

Success Boolean true

Indicates whether the call was successful.

TotalCount Long 0

The total number of instances that met the query conditions.


Sample request

     http(s)://[Endpoint]/? Action=ListInstances &<common request parameters> 

Sample success responses

XML format

     <TotalCount>7</TotalCount> <RequestId>98D35416-2B92-4CE5-8FD2-B1E61E165536</RequestId> <Success>true</Success> <InstanceList> </InstanceList> 


     { "TotalCount": 7, "RequestId": "98D35416-2B92-4CE5-8FD2-B1E61E165536", "Success": true, "InstanceList": { "Instance": [ ] } } 

Error codes

For more information about error codes, see error center.