All Products
Search

This Product

    PolarDB:DescribeDBInstanceAttribute

    Document Center

    PolarDB:DescribeDBInstanceAttribute

    Last Updated:Oct 30, 2026

    Retrieves the attributes of an instance.

    Operation description

    This operation retrieves the list of custom endpoints configured by the user to facilitate the management and viewing of private connections or VPC endpoint service settings.

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

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region of the instance.

    cn-hangzhou
    DBInstanceName

    string

    Yes

    The name of the instance.

    pxc-********
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-aekzaxhezhs5***

    Response elements

    Element

    Type

    Description

    Example

    object

    DBInstance

    object

    The database instance information.

    AiGatewayEnabled

    string

    Indicates whether the AI gateway is enabled.

    true
    CanNotCreateColumnar

    boolean

    Indicates whether the column store index feature is supported.

    true
    CnNodeClassCode

    string

    The CN node specifications. Valid values:

    • polarx.x4.medium.2e: 2 cores and 8 GB of memory

    • polarx.x4.large.2e: 4 cores and 16 GB of memory

    • polarx.x8.large.2e: 4 cores and 32 GB of memory

    • polarx.x4.xlarge.2e: 8 cores and 32 GB of memory

    • polarx.x8.xlarge.2e: 8 cores and 64 GB of memory

    • polarx.x4.2xlarge.2e: 16 cores and 64 GB of memory

    • polarx.x8.2xlarge.2e: 16 cores and 128 GB of memory

    • polarx.x4.4xlarge.2e: 32 cores and 128 GB of memory

    • polarx.x8.4xlarge.2e: 32 cores and 256 GB of memory

    • polarx.st.8xlarge.2e: 60 cores and 470 GB of memory

    • polarx.st.12xlarge.2e: 90 cores and 720 GB of memory

    polarx.x4.xlarge.2e
    CnNodeCount

    integer

    The number of CN nodes.

    2
    ColumnarInstanceName

    string

    The name of the column store engine instance.

    xxxx
    ColumnarReadDBInstances

    array

    The information about the column store read-only instances.

    string

    The information about the column store read-only instances.

    xxx
    CommodityCode

    string

    The commodity type of the instance. The value is fixed to drds_polarxpost_public_cn.

    drds_polarxpost_public_cn
    ConnAddrs

    array<object>

    The endpoint information.

    object

    The connection information of the instance.

    ConnectionString

    string

    The endpoint.

    polardbx-xxx.aliyuncs.com
    Port

    integer

    The connection port number.

    3306
    Type

    string

    The connection type. Valid values:

    • VPC: internal network connection

    • PUBLIC: public network connection

    VPC
    VPCId

    string

    The VPC ID.

    vpc-xxxxxx
    VSwitchId

    string

    The vSwitch ID.

    vsw-*********
    VpcInstanceId

    string

    The internal CloudInstanceId in the VPC. You can ignore this parameter.

    pxc-zkralxpc5d****
    ConnectionString

    string

    The internal network connection information.

    pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com
    CpuType

    string

    The chip type. Default value: intel.

    intel | hygon
    CreateTime

    string

    The creation time.

    2021-08-31T08:56:25.000+0000
    DBInstanceType

    string

    The instance type. Valid values:

    • ReadWrite: primary instance

    • ReadOnly: read-only instance

    ReadWrite
    DBNodeClass

    string

    The node specifications of the instance.

    polarx.x4.large.2e
    DBNodeCount

    integer

    The number of nodes in the instance.

    2
    DBNodes

    array<object>

    The database node information.

    object

    The node information.

    ComputeNodeId

    string

    The name of the compute node.

    pxc-i-********
    DataNodeId

    string

    The name of the storage node.

    pxc-xdb-xxxxxx
    Id

    string

    The logical node ID.

    pxi-*********
    NodeClass

    string

    The node specifications.

    polarx.x4.large.2e
    RegionId

    string

    The region ID of the node.

    cn-hangzhou
    ZoneId

    string

    The zone name of the node.

    cn-hangzhou-a
    DBType

    string

    The database type. The value is fixed to polarx.

    polarx
    DBVersion

    string

    The database version.

    5.5
    Description

    string

    The instance description.

    test instance
    DifferentDNSpec

    boolean

    Indicates whether the specifications of the DN nodes in the instance are different. Valid values:

    • true: The specifications are different.

    • false: The specifications are the same.

    false
    DnNodeClassCode

    string

    The DN node specifications. Valid values:

    • mysql.n2.medium.25: 2 cores and 4 GB of memory

    • mysql.n4.medium.25: 2 cores and 8 GB of memory

    • mysql.x8.medium.25: 2 cores and 16 GB of memory

    • mysql.n2.large.25: 4 cores and 8 GB of memory

    • mysql.n4.large.25: 4 cores and 16 GB of memory

    • mysql.x8.large.25: 4 cores and 32 GB of memory

    • mysql.n2.xlarge.25: 8 cores and 16 GB of memory

    • mysql.n4.xlarge.25: 8 cores and 32 GB of memory

    • mysql.x8.xlarge.25: 8 cores and 64 GB of memory

    • mysql.n4.2xlarge.25: 16 cores and 64 GB of memory

    • mysql.x8.2xlarge.25: 16 cores and 128 GB of memory

    • mysql.x4.4xlarge.25: 32 cores and 128 GB of memory

    • mysql.x8.4xlarge.25: 32 cores and 256 GB of memory

    • mysql.st.8xlarge.25: 60 cores and 470 GB of memory

    • mysql.st.12xlarge.25: 90 cores and 720 GB of memory

    mysql.x8.large.25
    DnNodeCount

    integer

    The number of DN nodes.

    2
    DnStorageSpace

    string

    The disk space size of the storage node, in GB.

    20
    Engine

    string

    The database type. The value is fixed to polarx.

    polarx
    EngineVersion

    string

    The DPI engine version. Default value: 2.0.

    2.0 | 3.0
    ExpireDate

    string

    The expiration time. The format is yyyy-MM-ddTHH:mm:ss.sss+0000 (UTC).

    2022-08-31T16:00:00.000+0000
    Expired

    string

    Indicates whether the instance has expired. Valid values:

    • true: expired

    • false: normal

    false
    GdnInstanceName

    string

    The name of the GDN instance.

    gdn-zkrkuykqglbizdhm
    GdnMemberList

    array<object>

    The GDN member list.

    object

    MemberName

    string

    The member name, which is the PolarDB-X instance name.

    pxc
    Role

    string

    The node role. Valid values:

    • master: primary node

    • standby: secondary node

    polarx_cn
    Status

    string

    The status.

    enabled
    GdnRole

    string

    The GDN role.

    master | standby
    Id

    string

    The ID of the primary instance. If this parameter is not returned, the instance is a primary instance.

    pxc-zkralxpc5d****
    KindCode

    integer

    The instance DPI engine version. This is an internal parameter.

    18
    LTSVersions

    array

    The instance versions.

    string

    The LTS version number.

    X.X.X.X
    LatestMinorVersion

    string

    The latest Milvus version supported by the current instance.

    polarx-kernel_5.4.11-16301083_xcluster-20210805
    LockMode

    string

    The lock mode of the instance. Valid values:

    • Unlock: normal

    • ManualLock: manually locked

    • LockByExpiration: automatically locked due to expiration

    • LockByRestoration: automatically locked before rollback

    • LockByDiskQuota: automatically locked due to full disk space

    • LockReadInstanceByDiskQuota: automatically locked due to full disk space of the read-only instance

    Unlock
    MaintainEndTime

    string

    The end time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.

    06:00
    MaintainStartTime

    string

    The start time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.

    06:00
    MinorVersion

    string

    The current Milvus version.

    polarx-kernel_5.4.11-16301083_xcluster-20210805
    Network

    string

    The network type of the instance. Only VPC is supported, which indicates a virtual private cloud.

    VPC
    PayType

    string

    The billing method of the instance. Valid values:

    • Postpaid: pay-as-you-go

    • Prepaid: subscription

    Postpaid
    Port

    string

    The internal network connection port.

    3306
    PrimaryInstanceId

    string

    The primary instance ID.

    pxc-hzrof9vitnu8uu
    PrimaryZone

    string

    The primary zone.

    cn-shenzhen-e
    ReadDBInstances

    array

    The list of read-only instance names.

    string

    The read-only instance name.

    pxr-*********
    RegionId

    string

    The region of the instance.

    cn-hangzhou
    ResourceGroupId

    string

    The resource group ID.

    rg-*********
    RightsSeparationEnabled

    boolean

    The status of the three-role mode. Valid values:

    • false: disabled

    • true: enabled

    false
    RightsSeparationStatus

    string

    The status of the three-role mode. Valid values:

    • disabled: disabled

    • enabled: enabled

    • processing: processing

    • unknown: unknown, which may be caused by the inability to connect to the instance

    disabled
    SearchEnabled

    boolean

    Indicates whether an associated Search instance that is not deleted exists, including instances that are being created or deleted.

    SearchInstance

    object

    The unique Search instance associated with the current primary instance. This parameter is empty if the feature is not enabled.

    InstanceId

    string

    The name of the Search engine instance.

    pxs-***
    Status

    string

    The status of the Search engine.

    Running
    SecondaryZone

    string

    The secondary zone.

    cn-shenzhen-a
    Series

    string

    The instance edition. Valid values:

    • enterprise: Enterprise Edition

    • standard: Standard Edition

    enterprise
    SpecCategory

    string

    exclusive: Exclusive. general: General.

    exclusive | general
    Status

    string

    The instance status. For more information, see the following description.

    Running
    StorageType

    string

    The storage type.

    custom_local_ssd | cloud_auto
    StorageUsed

    integer

    The used storage capacity, in bytes.

    17042505728
    TagSet

    array<object>

    The tag set.

    object

    The instance tags.

    Key

    string

    The tag key.

    key2
    Value

    string

    The tag value.

    value2
    TertiaryZone

    string

    The third zone.

    cn-shenzhen-e
    TopologyType

    string

    The topology type. Valid values:

    • 3azones: Three-zone deployment.

    • 1azone: Single-zone deployment.

    3azones
    Type

    string

    The instance type. Valid values:

    • ReadWrite: primary instance

    • ReadOnly: read-only instance

    ReadWrite
    VPCId

    string

    The VPC ID.

    vpc-xxxxx
    VSwitchId

    string

    The vSwitch ID.

    vsw-********
    ZoneId

    string

    The zone where the instance is located.

    cn-hangzhou-a
    RequestId

    string

    The request ID.

    9B2F3840-5C98-475C-B269-2D5C3A31797C

    Instance status table:

    StatusDescription
    CREATINGCreating
    RunningActive
    DeletingDeleting
    RESTARTINGRestarting
    HBASE_COLD_EXPANDINGExpanding cold storage
    ClassChangingChanging instance specifications
    NodeCreatingAdding nodes
    NodeDeletingRemoving nodes
    MinorVersionUpgradingUpgrading the minor version
    INS_MAINTAININGUnder maintenance
    ACTIVATIONUnder maintenance
    READINS_MAINTAININGRead-only instances under maintenance
    TRANSINGMigrating
    TRANSING_ACCROSSMigrating across zones
    NET_CREATINGCreating network connections
    NET_DELETINGReleasing network connections
    NET_MODIFYINGModifying network connections
    HA_SWITCHINGPerforming primary/secondary switchover
    CONFIG_SWITCHINGUpdating configurations
    SSL_MODIFYINGModifying SSL settings
    TDE_MODIFYINGModifying TDE settings

    Examples

    Success response

    JSON format

    {
  "DBInstance": {
    "AiGatewayEnabled": "true",
    "CanNotCreateColumnar": true,
    "CnNodeClassCode": "polarx.x4.xlarge.2e",
    "CnNodeCount": 2,
    "ColumnarInstanceName": "xxxx",
    "ColumnarReadDBInstances": [
      "xxx"
    ],
    "CommodityCode": "drds_polarxpost_public_cn",
    "ConnAddrs": [
      {
        "ConnectionString": "polardbx-xxx.aliyuncs.com",
        "Port": 3306,
        "Type": "VPC",
        "VPCId": "vpc-xxxxxx",
        "VSwitchId": "vsw-*********",
        "VpcInstanceId": "pxc-zkralxpc5d****"
      }
    ],
    "ConnectionString": "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
    "CpuType": "intel | hygon",
    "CreateTime": "2021-08-31T08:56:25.000+0000",
    "DBInstanceType": "ReadWrite",
    "DBNodeClass": "polarx.x4.large.2e",
    "DBNodeCount": 2,
    "DBNodes": [
      {
        "ComputeNodeId": "pxc-i-********",
        "DataNodeId": "pxc-xdb-xxxxxx",
        "Id": "pxi-*********",
        "NodeClass": "polarx.x4.large.2e",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-a"
      }
    ],
    "DBType": "polarx",
    "DBVersion": "5.5",
    "Description": "test instance",
    "DifferentDNSpec": false,
    "DnNodeClassCode": "mysql.x8.large.25",
    "DnNodeCount": 2,
    "DnStorageSpace": "20",
    "Engine": "polarx",
    "EngineVersion": "2.0 | 3.0",
    "ExpireDate": "2022-08-31T16:00:00.000+0000",
    "Expired": "false",
    "GdnInstanceName": "gdn-zkrkuykqglbizdhm",
    "GdnMemberList": [
      {
        "MemberName": "pxc",
        "Role": "polarx_cn",
        "Status": "enabled"
      }
    ],
    "GdnRole": "master | standby",
    "Id": "pxc-zkralxpc5d****",
    "KindCode": 18,
    "LTSVersions": [
      "X.X.X.X"
    ],
    "LatestMinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "LockMode": "Unlock",
    "MaintainEndTime": "06:00",
    "MaintainStartTime": "06:00",
    "MinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "Network": "VPC",
    "PayType": "Postpaid",
    "Port": "3306",
    "PrimaryInstanceId": "pxc-hzrof9vitnu8uu",
    "PrimaryZone": "cn-shenzhen-e",
    "ReadDBInstances": [
      "pxr-*********"
    ],
    "RegionId": "cn-hangzhou",
    "ResourceGroupId": "rg-*********",
    "RightsSeparationEnabled": false,
    "RightsSeparationStatus": "disabled",
    "SearchEnabled": false,
    "SearchInstance": {
      "InstanceId": "pxs-***",
      "Status": "Running"
    },
    "SecondaryZone": "cn-shenzhen-a",
    "Series": "enterprise",
    "SpecCategory": "exclusive | general",
    "Status": "Running",
    "StorageType": "custom_local_ssd | cloud_auto",
    "StorageUsed": 17042505728,
    "TagSet": [
      {
        "Key": "key2",
        "Value": "value2"
      }
    ],
    "TertiaryZone": "cn-shenzhen-e",
    "TopologyType": "3azones",
    "Type": "ReadWrite",
    "VPCId": "vpc-xxxxx",
    "VSwitchId": "vsw-********",
    "ZoneId": "cn-hangzhou-a"
  },
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.