DescribeDbInstances - PolarDB - Alibaba Cloud Documentation Center

Queries the list of storage-layer instances, such as ApsaraDB RDS or PolarDB instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

drds:DescribeDbInstances

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId1}/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds************
Search	string	No	The instance ID or cluster ID of the storage layer instance.	pc-***************
DbInstType	string	No	The storage-layer type. Valid values: POLARDB and RDS.	POLARDB
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	293275B3-8FC0-4619-A26E-6F062FASD56R
Items	object
DBInstance	array<object>	The list of instance details.
	array<object>
InstanceNetworkType	string	The network type of the storage layer. Valid values: VPC: VPC CLASSIC : Classic Network	VPC
DBInstanceType	string	The storage layer instance type.	Primary
ZoneId	string	The ID of the zone where the storage instance resides.	cn-hangzhou-a
DBInstanceStatus	integer	Storage layer instance status. Valid values: 0: creating 1: In use 3: Deleting 5: restarting 6: upgrading /Downgrading 7: Recovering 8: switching the Internet and intranet	0
DBInstanceId	string	The ID of the storage instance.	rm-****************
Engine	string	The engine of the storage instance.	存储层实例内核。
DBInstanceDescription	string	The description of the storage instance.	test
EngineVersion	string	The version of the engine for the storage instance.	5.7
RegionId	string	The ID of the region where the storage instance resides.	cn-hangzhou
ReadOnlyDBInstanceId	object
ReadOnlyDBInstanceId	array	The details about a read-only storage instance.
	string	Read-only instance under the storage layer instance.	[]
AllowAllCategory	boolean

Examples

Success response

JSON format

{
  "RequestId": "293275B3-8FC0-4619-A26E-6F062FASD56R",
  "Items": {
    "DBInstance": [
      {
        "InstanceNetworkType": "VPC",
        "DBInstanceType": "Primary",
        "ZoneId": "cn-hangzhou-a",
        "DBInstanceStatus": 0,
        "DBInstanceId": "rm-****************",
        "Engine": "存储层实例内核。",
        "DBInstanceDescription": "test",
        "EngineVersion": "5.7",
        "RegionId": "cn-hangzhou",
        "ReadOnlyDBInstanceId": {
          "ReadOnlyDBInstanceId": [
            "[]"
          ]
        },
        "AllowAllCategory": false
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	ActionUnauthorized	The specified action is not available for you
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidDRDSInstanceId.NotFound	The DrdsInstanceId provided does not exist in our records.
404	InvalidDbName.NotFound	The Drds DbName provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.