All Products
Search

This Product

    PolarDB:DescribeDrdsRdsInstances

    Document Center

    PolarDB:DescribeDrdsRdsInstances

    Last Updated:Oct 26, 2026

    Queries the details of all private custom RDS instances under the specified PolarDB-X instance.

    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:DescribeDrdsRdsInstances

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DrdsInstanceId

    string

    Yes

    The ID of the DRDS instance.

    Note

    You can call the DescribeDrdsInstances operation to query the details of all instances under the specified account, including the instance IDs.

    drds*************

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    123DB16B-02F2-45F7-A571-843991******
    Success

    boolean

    Indicates whether the request is successful.

    true
    DbInstances

    object

    DbInstance

    array<object>

    The details of the private custom RDS instances at the storage layer.

    object

    DBInstanceCPU

    string

    The number of CPU cores of the private custom RDS instance at the storage layer.

    8
    DBInstanceMemory

    integer

    The memory of the private custom RDS instance at the storage layer. Unit: MB.

    8192
    PayType

    string

    The billing method of the private custom RDS instance at the storage layer. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    PostPaid
    DBInstanceStatus

    string

    The status of the private custom RDS instance at the storage layer. Valid values:

    • 0: The instance is being created.

    • 1: The instance is running.

    • 3: The instance is being deleted.

    • 5: The instance is being restarted.

    • 6: The instance is being upgraded or downgraded.

    • 7: Backup is in progress.

    • 8: The instance is switching between internal and public networks.

    • 9: Instance migration is in progress.

    • 11: Data is being migrated.

    • 12: A disaster recovery instance is being created.

    • 13: Data import is in progress.

    • 14: Data is being imported from another RDS instance.

    • 15: A disaster recovery switchover is in progress.

    • 16: A temporary instance is being created.

    • 17: The network is being created.

    • 18: The instance is being cloned.

    • 19: A link switchover is in progress.

    • 20: A read-only instance is being migrated.

    1
    NetworkType

    string

    The network type of the private custom RDS instance at the storage layer. The value is fixed to VPC.

    VPC
    Port

    integer

    The internal network connection port.

    3306
    EngineVersion

    string

    The database engine version number (not the DPI engine) of the private custom RDS instance at the storage layer. The value is fixed to 8.0.

    8.0
    DmInstanceId

    string

    The resource ID.

    dm-*************
    DBInstanceStorage

    integer

    The storage capacity of the private custom RDS instance at the storage layer. Unit: GB.

    20
    ConnectUrl

    string

    The internal network connection endpoint of the private custom RDS instance at the storage layer.

    rm-***************.mysql.rds.aliyuncs.com
    ReadWeight

    integer

    The read weight of the specified private custom RDS instance at the storage layer.

    0
    RdsInstType

    string

    The type of the private custom RDS instance at the storage layer. Valid values:

    • Primary: primary instance.

    • Readonly: read-only instance.

    Primary
    DBInstanceClassType

    string

    The instance family. Valid values:

    • x: general-purpose.

    • d: dedicated.

    • h: exclusive physical host.

    x
    DBInstanceId

    string

    The instance ID of the private custom RDS instance at the storage layer.

    rm-*****************
    Engine

    string

    The engine type of the private custom RDS instance at the storage layer. The value is fixed to MySQL.

    MySQL
    DbInstType

    string

    The instance type at the storage layer. The value is fixed to RDS.

    RDS
    LockMode

    integer

    The lock status of the RDS instance. Valid values:

    • 0: Normal.

    • 1: Manually locked.

    • 2: Automatically locked due to expiration.

    • 3: Automatically locked before a rollback.

    • 4: Automatically locked because the storage is full.

    • 5: Automatically locked because the storage of the read-only instance is full.

    1
    LockReason

    string

    The reason why the RDS instance is locked.

    Manually locked

    Examples

    Success response

    JSON format

    {
  "RequestId": "123DB16B-02F2-45F7-A571-843991******",
  "Success": true,
  "DbInstances": {
    "DbInstance": [
      {
        "DBInstanceCPU": "8",
        "DBInstanceMemory": 8192,
        "PayType": "PostPaid",
        "DBInstanceStatus": "1",
        "NetworkType": "VPC",
        "Port": 3306,
        "EngineVersion": "8.0",
        "DmInstanceId": "dm-*************",
        "DBInstanceStorage": 20,
        "ConnectUrl": "rm-***************.mysql.rds.aliyuncs.com",
        "ReadWeight": 0,
        "RdsInstType": "Primary",
        "DBInstanceClassType": "x",
        "DBInstanceId": "rm-*****************",
        "Engine": "MySQL",
        "DbInstType": "RDS",
        "LockMode": 1,
        "LockReason": "手动触发锁"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError The request processing has failed due to some unknown error.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.