All Products
Search

This Product

    PolarDB:DescribeDBInstances

    Document Center

    PolarDB:DescribeDBInstances

    Last Updated:Sep 10, 2026

    Queries a list of instances by calling the DescribeDBInstances operation.

    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

    polardbx:DescribeDBInstances

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the instance.

    cn-hangzhou
    PageNumber

    integer

    No

    The page number. Pages start from 1.

    1
    PageSize

    integer

    No

    The page size. Valid values:

    30
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-acfmyst47******
    Tags

    string

    No

    The list of tags.

    [{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}]
    InstanceId

    string

    No

    The instance ID.

    dinga93c84f4d***
    Series

    string

    No

    The instance edition. Valid values:

    enterprise
    MustHasCdc

    boolean

    No

    Specifies whether the instance must have a log engine.

    true
    DbVersion

    string

    No

    Description

    string

    No

    The description of the database.

    app-test

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

    C458B1E8-1683-3645-B154-6BA32080EEA
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The page size.

    30
    TotalNumber

    integer

    The total number of entries.

    30
    DBInstances

    array<object>

    The list of instances.

    array<object>

    The instance details.

    Type

    string

    The instance type.

    ReadWrite
    Status

    string

    The instance status. For more information, see Instance status table.

    Running
    CommodityCode

    string

    The commodity code.

    drds_polarxpre_public_cn
    ExpireTime

    string

    The expiration time.

    2021-12-01T16:00:00.000+0000
    Expired

    boolean

    Indicates whether the instance has expired.

    false
    CreateTime

    string

    The creation time.

    2021-11-01T03:49:50.000+0000
    PayType

    string

    The billing method of the instance. Valid values:

    Prepaid
    LockReason

    string

    The lock reason.

    Overdue
    DBType

    string

    The database type.

    polarx
    LockMode

    string

    Indicates whether the instance is locked.

    Unlock
    VPCId

    string

    VPC ID。

    VPCID
    MinorVersion

    string

    The current Milvus version.

    polarx-kernel_5.4.12-16349923_xcluster-20210926
    RegionId

    string

    The region ID.

    cn-hangzhou
    Network

    string

    The network type.

    VPC
    DBVersion

    string

    The database engine version.

    5.7
    Description

    string

    The database description.

    Test
    NodeClass

    string

    The node specifications.

    polarx.x4.large.2e
    StorageUsed

    integer

    The storage usage.

    40658534400
    NodeCount

    integer

    The number of nodes.

    5
    ZoneId

    string

    The zone ID.

    cn-hangzhou-g
    Engine

    string

    The engine type.

    polarx
    Id

    string

    The instance ID.

    pxc-hzr2yeov******
    Nodes

    array<object>

    The list of nodes.

    object

    The list of nodes.

    ZoneId

    string

    The zone ID.

    cn-hangzhou-g
    Id

    string

    The node ID.

    pxi-zd89wrzqh******
    RegionId

    string

    The region ID.

    cn-hangzhou-g-aliyun
    ClassCode

    string

    The instance specifications.

    polarx.x4.large.2e
    Name

    string

    ReadDBInstances

    array

    The list of read-only instances.

    string

    The name of the read-only instance.

    pxr-hzr2yeov******
    ColumnarReadDBInstances

    array

    The column store read-only instance information.

    string

    The column store read-only instance information.

    xxxxxxxx
    ResourceGroupId

    string

    The resource group ID.

    rg-xxxxxx
    TagSet

    array<object>

    The set of tags.

    object

    The set of tags.

    Key

    string

    The tag key.

    key1
    Value

    string

    The tag value.

    value1
    DBInstanceName

    string

    The database instance name.

    pxc-xxxxx
    DnNodeCount

    integer

    The number of DN nodes.

    2
    CnNodeCount

    integer

    The number of CN nodes.

    2
    CnNodeClassCode

    string

    The CN node specifications.

    polarx.x4.large.2e
    DnNodeClassCode

    string

    The DN node specifications.

    mysql.n4.medium.25
    Series

    string

    The instance edition. Valid values:

    enterprise
    ContainBinlogX

    boolean

    Specifies whether the instance contains the multi-stream log service. Valid values:

    true
    SupportBinlogX

    boolean

    Indicates whether the instance supports multi-stream. Valid values:

    true
    CdcInstanceName

    string

    The name of the log node.

    pxc-c-dmlgit****
    TopologyType

    string

    The topology type.

    3azones
    TertiaryZone

    string

    The tertiary active zone for three-zone deployment.

    cn-hangzhou-k
    PrimaryZone

    string

    The primary zone.

    cn-hangzhou-j
    SecondaryZone

    string

    The secondary zone.

    cn-hangzhou-l
    ColumnarInstanceName

    string

    The name of the column store engine instance.

    xxxxxxxx
    isInGdn

    boolean

    gdnRole

    string

    CpuType

    string

    PrimaryInstanceId

    string

    StorageType

    string

    EngineVersion

    string

    Examples

    Success response

    JSON format

    {
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalNumber": 30,
  "DBInstances": [
    {
      "Type": "ReadWrite",
      "Status": "Running",
      "CommodityCode": "drds_polarxpre_public_cn",
      "ExpireTime": "2021-12-01T16:00:00.000+0000",
      "Expired": false,
      "CreateTime": "2021-11-01T03:49:50.000+0000",
      "PayType": "Prepaid",
      "LockReason": "Overdue.",
      "DBType": "polarx",
      "LockMode": "Unlock",
      "VPCId": "VPCID",
      "MinorVersion": "polarx-kernel_5.4.12-16349923_xcluster-20210926",
      "RegionId": "cn-hangzhou",
      "Network": "VPC",
      "DBVersion": "5.7",
      "Description": "Test.",
      "NodeClass": "polarx.x4.large.2e",
      "StorageUsed": 40658534400,
      "NodeCount": 5,
      "ZoneId": "cn-hangzhou-g",
      "Engine": "polarx",
      "Id": "pxc-hzr2yeov******",
      "Nodes": [
        {
          "ZoneId": "cn-hangzhou-g",
          "Id": "pxi-zd89wrzqh******",
          "RegionId": "cn-hangzhou-g-aliyun",
          "ClassCode": "polarx.x4.large.2e",
          "Name": ""
        }
      ],
      "ReadDBInstances": [
        "pxr-hzr2yeov******"
      ],
      "ColumnarReadDBInstances": [
        "xxxxxxxx"
      ],
      "ResourceGroupId": "rg-xxxxxx",
      "TagSet": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "DBInstanceName": "pxc-xxxxx",
      "DnNodeCount": 2,
      "CnNodeCount": 2,
      "CnNodeClassCode": "polarx.x4.large.2e",
      "DnNodeClassCode": "mysql.n4.medium.25",
      "Series": "enterprise",
      "ContainBinlogX": true,
      "SupportBinlogX": true,
      "CdcInstanceName": "pxc-c-dmlgit****",
      "TopologyType": "3azones",
      "TertiaryZone": "cn-hangzhou-k",
      "PrimaryZone": "cn-hangzhou-j",
      "SecondaryZone": "cn-hangzhou-l",
      "ColumnarInstanceName": "xxxxxxxx",
      "isInGdn": false,
      "gdnRole": "",
      "CpuType": "",
      "PrimaryInstanceId": "",
      "StorageType": "",
      "EngineVersion": ""
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.