Queries a list of instances.
Operation description
This operation is phased out.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rds:DescribeDBInstancesForClone | get | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
| proxyId | string | No | The ID of the proxy mode. | API |
| Engine | string | No | The database engine of the instance. Valid values:
By default, this operation queries the instances that run any of the supported database engine types. | MySQL |
| ZoneId | string | No | The zone ID of the instance. | cn-hangzhou-h |
| DBInstanceStatus | string | No | The status of the instance. For more information, see Instance state table. | Running |
| Expired | string | No | Specifies whether the instance expires. Valid values:
| True |
| SearchKey | string | No | The keyword that is used for the search. The keyword can be part of an instance ID or an instance description. | rm-uf6w |
| DBInstanceId | string | No | The ID of the instance. | rm-uf6wjk5xxxxxxxxxx |
| DBInstanceType | string | No | The role of the instance that you want to query. Valid values:
By default, this operation queries the instances of all roles. | Primary |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 30. | 30 |
| PageNumber | integer | No | The number of the page to return. | 1 |
| InstanceNetworkType | string | No | The network type of the instance. Valid values:
| Classic |
| VpcId | string | No | The ID of the virtual private cloud (VPC). | vpc-j6cjvqms29yxxxxxxxxxx |
| VSwitchId | string | No | The ID of the vSwitch. | vsw-j6csw46bgrgkxxxxxxxxxx |
| DBInstanceClass | string | No | The instance type of the instance. For more information, see Instance types. | mysql.n1.micro.1 |
| EngineVersion | string | No | The version of the database engine. | 5.7 |
| NodeType | string | No | The type of the database node. Valid values:
| Master |
| PayType | string | No | The billing method of the instance. Valid values:
By default, this operation queries the instances that use any of the supported billing methods. | Postpaid |
| ConnectionMode | string | No | The connection mode of the instance. Valid values:
By default, this operation queries the instances that use any of the supported connection modes. | Standard |
| CurrentInstanceId | string | No | The ID of the current instance. | rm-uf6wjk5xxxxxxxxxx |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
"PageNumber": 12,
"PageRecordCount": 10,
"TotalRecordCount": 120,
"Items": {
"DBInstance": [
{
"VpcId": "vpc-bp1opxu1zkhxxxxxxxxxx",
"ReplicateId": "N/A\n",
"TempDBInstanceId": "sub138xxxxx_rm-xxxxx",
"DBInstanceStorageType": "local_ssd",
"CreateTime": "2018-11-05T11:26:02Z",
"PayType": "Postpaid",
"MutriORsignle": false,
"ConnectionMode": "Standard",
"LockMode": "Unlock",
"EngineVersion": "5.7",
"VpcCloudInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"InsId": 1,
"InstanceNetworkType": "Classic",
"MasterInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"DBInstanceDescription": "Test",
"ExpireTime": "2018-11-28T11:26:02Z",
"DBInstanceNetType": "Intranet",
"DBInstanceType": "Primary",
"DestroyTime": "2018-12-05T11:26:02Z",
"LockReason": "instance_expired",
"DBInstanceStatus": "Running",
"GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
"RegionId": "cn-hangzhou",
"VSwitchId": "vsw-uf6adz52c2pxxxxxxxxxx\t",
"ResourceGroupId": "rg-acfmyxxxxx",
"ZoneId": "cn-hangzhou-h",
"DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
"Category": "HighAvailability",
"Engine": "MySQL",
"DBInstanceClass": "mysql.n1.micro.1",
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": [
{
"DBInstanceId": "rm-bpxxxxxxxxx"
}
]
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter"DBInstanceType" is not valid. | The operation failed. The instance type is invalid. Specify a valid instance type. |
| 400 | ApiError | API error. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-20 | API Description Update. The Error code has changed | View Change Details |