Queries the information about ApsaraDB for SelectDB instances.
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 |
|---|---|---|---|---|
| selectdb:DescribeDBInstances | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ResourceGroupId | string | No | The resource group ID. | rg-4690g37929**** |
| DBInstanceIds | string | No | The instance ID. Separate multiple instance IDs with commas (,). | selectdb-cn-7213cjv**** |
| DBInstanceStatus | string | No | The state of the instance. Valid values:
| ACTIVATION |
| DBInstanceDescription | string | No | The description of the instance. | |
| PageSize | long | No | The number of entries per page. Valid values:
| 30 |
| PageNumber | long | No | The page number. | 1 |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BC854513-E85E-54F3-9842-B9CCD3308CDD",
"PageNumber": 30,
"PageSize": 1,
"TotalRecordCount": 2,
"Items": [
{
"connectionString": "",
"DBInstanceId": "selectdb-cn-7213cjv****",
"Description": "",
"Engine": "selectdb",
"EngineVersion": "2.4",
"InstanceUsedType": "Instance",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"ChargeType": "PrePaid",
"Category": "basic",
"Status": "ACTIVATION",
"VpcId": "vpc-bp175iuvg8nxqraf2****",
"VswitchId": "vsw-bp1gzt31twhlo0sa5****",
"ResourceCpu": 8,
"ResourceMemory": 64,
"ScaleMin": 0,
"ScaleMax": 0,
"ScaleReplica": 0,
"StorageSize": 100,
"StorageType": "cloud_essd",
"ObjectStoreSize": 200,
"ExpireTime": "2024-03-29T03:47:05Z",
"LockMode": 0,
"LockReason": "nolock",
"IsDeleted": false,
"MaintainStarttime": "",
"MaintainEndtime": "",
"GmtCreated": "2023-08-12T04:14Z\n",
"GmtModified": "2023-08-12T19:05Z",
"ParentInstance": "",
"ResourceGroupId": "",
"MaintainStartTimeStr": "",
"MaintainEndTimeStr": "",
"TenantClusterId": "",
"TenantToken": "",
"TenantUserId": "",
"Tags": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
],
"ClusterCount": 1
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidPageNumber.Malformed | The specified parameter "PageNumber" is not valid. | The number of records per page parameter is illegal. |
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | english description1 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | english description1 |
| 400 | InvalidDBName | The specified database name is not allowed. | english description1 |
| 400 | CreateOrderFailed | Failed to create order. | Failed to create order. |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | The requested operation cannot be performed while the cluster is not running. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | english description1 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | english description1 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | The instance is in a state that does not support the current operation. |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | english description1 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | english description1 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | Not enough resources, please try again later. |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | english description1 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | english description1 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | - |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | english description1 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | english description1 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | english description1 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | english description1 |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-24 | The Error code has changed | View Change Details |
| 2024-06-12 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-12-27 | The response structure of the API has changed | View Change Details |