DocsICP FilingConsole
Documentation
Home Page PolarDB Developer Reference PolarDB for Xscale API Reference 2.0 (2020 Version) API overview Instance management DescribeDBInstanceAttribute

DescribeDBInstanceAttribute

Updated at:
Copy as MD
Product
My Favorites

Queries 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 ID.

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

RequestId

string

The request ID.

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

object

The database instance information.

Type

string

The instance type. Valid values:

  • ReadWrite: Primary instance.

  • ReadOnly: Read-only instance.

ReadWrite
Status

string

The instance status.

Running
RightsSeparationStatus

string

The three-role mode status. Valid values:

  • disabled: Disabled.

  • enabled: Enabled.

  • processing: Processing.

  • unknown: Unknown. This may be caused by a connection failure to the instance.

disabled
DBNodeCount

integer

The number of nodes in the instance.

2
Expired

string

Indicates whether the instance has expired. Valid values:

  • true: Expired.

  • false: Normal.

false
CreateTime

string

The creation time.

2021-08-31T08:56:25.000+0000
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
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 a rollback.

  • LockByDiskQuota: Automatically locked due to full storage space.

  • LockReadInstanceByDiskQuota: Automatically locked due to full storage space of the read-only instance.

Unlock
Description

string

The description of the instance.

test instance
ConnectionString

string

The internal network connection string.

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

integer

The used storage space, in bytes.

17042505728
ExpireDate

string

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

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

string

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

drds_polarxpost_public_cn
MaintainStartTime

string

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

06:00
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
LatestMinorVersion

string

The latest kernel Milvus version supported by the instance.

polarx-kernel_5.4.11-16301083_xcluster-20210805
MaintainEndTime

string

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

06:00
DBType

string

The database type. The value is fixed as polarx.

polarx
RightsSeparationEnabled

boolean

Indicates whether the three-role mode is enabled. Valid values:

  • false: Disabled.

  • true: Enabled.

false
VPCId

string

The VPC ID.

vpc-xxxxx
MinorVersion

string

The current kernel Milvus version.

polarx-kernel_5.4.11-16301083_xcluster-20210805
RegionId

string

The region ID.

cn-hangzhou
Network

string

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

VPC
DBVersion

string

The database version.

5.5
VSwitchId

string

The vSwitch ID.

vsw-********
ZoneId

string

The zone where the instance is deployed.

cn-hangzhou-a
Engine

string

The database type. The value is fixed as polarx.

polarx
KindCode

integer

The database engine version of the instance DPI engine. This is an internal parameter.

18
Id

string

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

pxc-zkralxpc5d****
DBNodes

array<object>

The database node information.

object

The node information.

ComputeNodeId

string

The name of the compute node.

pxc-i-********
NodeClass

string

The node specifications.

polarx.x4.large.2e
DataNodeId

string

The name of the storage node.

pxc-xdb-xxxxxx
ZoneId

string

The name of the zone where the node is deployed.

cn-hangzhou-a
Id

string

The logical node ID.

pxi-*********
RegionId

string

The region ID of the node.

cn-hangzhou
ConnAddrs

array<object>

The endpoint information.

object

The connection information of the instance.

Type

string

The connection type. VPC indicates an internal network connection, and PUBLIC indicates a public network connection.

VPC
VSwitchId

string

The vSwitch ID.

vsw-*********
Port

integer

The connection port number.

3306
VPCId

string

The VPC ID.

vpc-xxxxxx
ConnectionString

string

The endpoint.

polardbx-xxx.aliyuncs.com
VpcInstanceId

string

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

pxc-zkralxpc5d****
ReadDBInstances

array

The list of read-only instance names.

string

The name of the read-only instance.

pxr-*********
ColumnarReadDBInstances

array

The column store read-only instance information.

string

The column store read-only instance information.

xxx
ResourceGroupId

string

The resource group ID.

rg-*********
TagSet

array<object>

The tag set.

object

The instance tag.

Key

string

The tag key.

key2
Value

string

The tag value.

value2
CnNodeCount

integer

The number of CN nodes.

2
DnNodeCount

integer

The number of DN nodes.

2
CnNodeClassCode

string

The CN node specifications. Valid values:

  • polarx.x4.medium.2e: 2 cores, 8 GB

  • polarx.x4.large.2e: 4 cores, 16 GB

  • polarx.x8.large.2e: 4 cores, 32 GB

  • polarx.x4.xlarge.2e: 8 cores, 32 GB

  • polarx.x8.xlarge.2e: 8 cores, 64 GB

  • polarx.x4.2xlarge.2e: 16 cores, 64 GB

  • polarx.x8.2xlarge.2e: 16 cores, 128 GB

  • polarx.x4.4xlarge.2e: 32 cores, 128 GB

  • polarx.x8.4xlarge.2e: 32 cores, 256 GB

  • polarx.st.8xlarge.2e: 60 cores, 470 GB

  • polarx.st.12xlarge.2e: 90 cores, 720 GB

polarx.x4.xlarge.2e
DnNodeClassCode

string

The DN node specifications. Valid values:

  • mysql.n2.medium.25: 2 cores, 4 GB

  • mysql.n4.medium.25: 2 cores, 8 GB

  • mysql.x8.medium.25: 2 cores, 16 GB

  • mysql.n2.large.25: 4 cores, 8 GB

  • mysql.n4.large.25: 4 cores, 16 GB

  • mysql.x8.large.25: 4 cores, 32 GB

  • mysql.n2.xlarge.25: 8 cores, 16 GB

  • mysql.n4.xlarge.25: 8 cores, 32 GB

  • mysql.x8.xlarge.25: 8 cores, 64 GB

  • mysql.n4.2xlarge.25: 16 cores, 64 GB

  • mysql.x8.2xlarge.25: 16 cores, 128 GB

  • mysql.x4.4xlarge.25: 32 cores, 128 GB

  • mysql.x8.4xlarge.25: 32 cores, 256 GB

  • mysql.st.8xlarge.25: 60 cores, 470 GB

  • mysql.st.12xlarge.25: 90 cores, 720 GB

mysql.x8.large.25
Series

string

The instance edition. Valid values:

  • enterprise: Enterprise Edition.

  • standard: Standard Edition.

enterprise
LTSVersions

array

The instance version.

string

The LTS version number.

X.X.X.X
TopologyType

string

The topology type. Valid values:

  • 3azones: Three-zone deployment.

  • 1azone: Single-zone deployment.

3azones
PrimaryZone

string

The primary zone.

cn-shenzhen-e
SecondaryZone

string

The secondary zone.

cn-shenzhen-a
TertiaryZone

string

The third zone in a Three-zone deployment.

cn-shenzhen-e
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
ColumnarInstanceName

string

The name of the column store engine instance.

xxxx
CanNotCreateColumnar

boolean

Indicates whether the In-Memory Column Index (IMCI) feature is supported.

true
GdnInstanceName

string

The GDN instance name.

gdn-zkrkuykqglbizdhm
GdnMemberList

array<object>

The GDN member list.

object

Role

string

The role of the node. Valid values:

  • master: The primary node.

  • standby: The secondary node.

polarx_cn
MemberName

string

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

pxc
Status

string

The status.

enabled
SpecCategory

string

The specification category. Valid values:

  • exclusive: Dedicated.

  • general: General-purpose.

exclusive | general
GdnRole

string

The role in the global database network (GDN).

master | standby
PrimaryInstanceId

string

The primary instance ID.

pxc-hzrof9vitnu8uu
StorageType

string

The storage type.

custom_local_ssd | cloud_auto
CpuType

string

The processor type. Default value: intel.

intel | hygon
EngineVersion

string

The database engine version. Default value: 2.0.

2.0 | 3.0
DnStorageSpace

string

The disk space of the storage node. Unit: GB.

20
AiGatewayEnabled

string

Specifies whether the AI gateway is enabled.

true

Instance status table:

StatusDescription
CREATINGCreating
RunningRunning
DeletingDeleting
RESTARTINGRestarting
HBASE_COLD_EXPANDINGCold storage expansion in progress
ClassChangingChanging instance specifications
NodeCreatingAdding nodes
NodeDeletingRemoving nodes
MinorVersionUpgradingUpgrading minor version
INS_MAINTAININGUnder maintenance
ACTIVATIONUnder maintenance
READINS_MAINTAININGRead-only instance under maintenance
TRANSINGMigrating
TRANSING_ACCROSSMigrating across zones
NET_CREATINGCreating network connectivity
NET_DELETINGReleasing network connectivity
NET_MODIFYINGModifying network connectivity
HA_SWITCHINGPerforming primary/secondary switchover
CONFIG_SWITCHINGUpdating configuration
SSL_MODIFYINGModifying SSL
TDE_MODIFYINGModifying TDE

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：DeleteDBInstanceNext：DescribeDBInstanceConfig