DescribeDBInstanceAttribute - PolarDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstanceAttribute	The operation that you want to perform. Set the value to DescribeDBInstanceAttribute.
RegionId	String	Yes	cn-hangzhou	The region ID of the instance.
DBInstanceName	String	Yes	pxc-********	The name of the instance.
ResourceGroupId	String	No	rg-aekzaxhezhs5***	The resource group ID.

Response parameters

Parameter	Type	Example	Description
RequestId	String	9B2F3840-5C98-475C-B269-2D5C3A31797C	The request ID.
DBInstance	Object		The information about the instance.
Type	String	ReadWrite	The role of the instance. Valid values: ReadWrite: The instance is a primary instance. ReadOnly: The instance is a read-only instance.
Status	String	Running	The status of the instance. For more information, see Instance states.
RightsSeparationStatus	String	disabled	Indicates whether the three-role mode is enabled. Valid values: disabled: The three-role mode is disabled. enabled: The three-role mode is enabled. processing: The three-role mode is being configured. unknown: An unknown error has occurred. This value is returned if the instance cannot be connected.
DBNodeCount	Integer	2	The number of instance nodes.
Expired	String	false	Indicates whether the instance has expired. Valid values: true: The instance has expired. false: The instance has not expired.
CreateTime	String	2021-08-31T08:56:25.000+0000	The time when the instance was created.
PayType	String	Postpaid	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
Port	String	3306	The port that is used to connect to the instance over internal networks.
LockMode	String	Unlock	The lock status of the instance. Valid values: Unlock: The instance is unlocked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked upon expiration. LockByRestoration: The instance is automatically locked before a rollback. LockByDiskQuota: The instance is automatically locked because the disk space is exhausted. LockReadInstanceByDiskQuota: The instance is a read-only instance that is automatically locked when the disk space is exhausted.
Description	String	test instance	The description of the instance.
ConnectionString	String	pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com	The domain name that is used to connect to the instance over internal networks.
StorageUsed	Long	17042505728	The storage capacity that is used by the instance. Unit: bytes.
ExpireDate	String	2022-08-31T16:00:00.000+0000	The point in time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ss.sss+0000 format. The time is displayed in UTC.
CommodityCode	String	drds_polarxpost_public_cn	The instance category. This parameter is automatically set to drds_polarxpost_public_cn.
MaintainStartTime	String	06:00	The beginning of the maintenance window of the instance. The start time is displayed in UTC. In the PolarDB-X console, the start time is displayed in UTC+8.
DBInstanceType	String	ReadWrite	The role of the instance. Valid values: ReadWrite: The instance is a primary instance. ReadOnly: The instance is a read-only instance.
DBNodeClass	String	polarx.x4.large.2e	The instance type of each node for the instance.
LatestMinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	The latest minor kernel version that is supported by the instance.
MaintainEndTime	String	06:00	The end of the maintenance window of the instance. The end time is displayed in UTC. In the PolarDB-X console, the end time is displayed in UTC+8.
DBType	String	polarx	The type of the databases in the instance. This parameter is automatically set to polarx.
RightsSeparationEnabled	Boolean	false	Indicates whether the three-role mode is enabled. Valid values: false: The three-role mode is disabled. true: The three-role mode is enabled.
VPCId	String	vpc-xxxxx	The ID of the virtual private cloud (VPC) in which the instance is deployed.
MinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	The minor engine version of the instance.
RegionId	String	cn-hangzhou	The region ID of the instance.
Network	String	VPC	The network type of the instance. This parameter is automatically set to VPC.
DBVersion	String	5.5	The database engine version of the instance.
VSwitchId	String	vsw-********	The ID of the vSwitch to which the instance is connected.
ZoneId	String	cn-hangzhou-a	The zone ID of the instance.
Engine	String	polarx	The type of the databases in the instance. This parameter is automatically set to polarx.
KindCode	Integer	18	The version of the instance engine. This parameter is an internal parameter.
Id	String	pxc-zkralxpc5d****	The ID of the primary instance. If the instance is a primary instance, this parameter is not returned.
DBNodes	Array of DBNode		The information about the database nodes in the instance.
ComputeNodeId	String	pxc-i-********	The name of the compute node.
NodeClass	String	polarx.x4.large.2e	The instance type of the node.
DataNodeId	String	pxc-xdb-xxxxxx	The name of the data node.
ZoneId	String	cn-hangzhou-a	The name of the zone in which the node is deployed.
Id	String	pxi-*********	The ID of the logical node.
RegionId	String	cn-hangzhou	The region ID of the node.
ConnAddrs	Array of ConnAddr		The information about connection strings.
Type	String	VPC	The connection type. The value VPC indicates that the instance is connected by using VPCs. The value PUBLIC indicates that the instance is connected over the Internet.
VSwitchId	String	vsw-*********	The ID of the vSwitch to which the instance is connected.
Port	Long	3306	The port number that is used to connect to the instance.
VPCId	String	vpc-xxxxxx	The ID of the VPC in which the instance is deployed.
ConnectionString	String	polardbx-xxx.aliyuncs.com	The domain name that is used to connect to the instance.
VpcInstanceId	String	pxc-zkralxpc5d****	The ID of the cloud instance within the VPC. You can ignore this parameter.
ReadDBInstances	Array of String	pxr-*********	The names of the read-only instances.
ResourceGroupId	String	rg-*********	The resource group ID.
TagSet	Array of TagSet		Details about the tags.
Key	String	key2	The tag key.
Value	String	value2	The tag value.
CnNodeCount	Integer	2	The number of compute nodes in the instance.
DnNodeCount	Integer	2	The number of data nodes in the instance.
CnNodeClassCode	String	polarx.x4.xlarge.2e	The instance type of the compute node. Valid values: polarx.x4.medium.2e: 2 CPU cores and 8 GB of memory polarx.x4.large.2e: 4 CPU cores and 16 GB of memory polarx.x8.large.2e: 4 CPU cores and 32 GB of memory polarx.x4.xlarge.2e: 8 CPU cores and 32 GB of memory polarx.x8.xlarge.2e: 8 CPU cores and 64 GB of memory polarx.x4.2xlarge.2e: 16 CPU cores and 64 GB of memory polarx.x8.2xlarge.2e: 16 CPU cores and 128 GB of memory polarx.x4.4xlarge.2e: 32 CPU cores and 128 GB of memory polarx.x8.4xlarge.2e: 32 CPU cores and 256 GB of memory polarx.st.8xlarge.2e: 60 CPU cores and 470 GB of memory polarx.st.12xlarge.2e: 90 CPU cores and 720 GB of memory
DnNodeClassCode	String	mysql.x8.large.25	The instance type of the data node. Valid values: mysql.n2.medium. 25: 2 CPU cores and 4 GB of memory mysql.n4.medium. 25: 2 CPU cores and 8 GB of memory mysql.x8.medium.25: 2 CPU cores and 16 GB of memory mysql.n2.large.25: 4 CPU cores and 8 GB of memory mysql.n4.large.25: 4 CPU cores and 16 GB of memory mysql.x8.large.25: 4 CPU cores and 32 GB of memory mysql.n2.xlarge.25: 8 CPU cores and 16 GB of memory mysql.n4.xlarge.25: 8 CPU cores and 32 GB of memory mysql.x8.xlarge.25: 8 CPU cores and 64 GB of memory mysql.n4.2xlarge.25: 16 CPU cores and 64 GB of memory mysql.x8.2xlarge.25: 16 CPU cores and 128 GB of memory mysql.x4.4xlarge.25: 32 CPU cores and 128 GB of memory mysql.x8.4xlarge.25: 32 CPU cores and 256 GB of memory mysql.st.8xlarge.25: 60 CPU cores and 470 GB of memory mysql.st.12xlarge.25: 90 CPU cores and 720 GB of memory
Series	String	enterprise	The edition of the instance. Valid values: enterprise: Enterprise Edition standard: Standard Edition
LTSVersions	Array of String	X.X.X.X	The Long Term Support (LTS) version.
TopologyType	String	3azones	The topology type of the instance. Valid values: 3azones: The instance is deployed in three zones. 1azone: The instance is deployed in only one zone.
PrimaryZone	String	cn-shenzhen-e	The primary zone.
SecondaryZone	String	cn-shenzhen-a	The secondary zone.
TertiaryZone	String	cn-shenzhen-e	The tertiary zone.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&ResourceGroupId=rg-aekzaxhezhs5***
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceAttributeResponse>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <DBInstance>
        <Type>ReadWrite</Type>
        <Status>Running</Status>
        <RightsSeparationStatus>disabled</RightsSeparationStatus>
        <DBNodeCount>2</DBNodeCount>
        <Expired>false</Expired>
        <CreateTime>2021-08-31T08:56:25.000+0000</CreateTime>
        <PayType>Postpaid</PayType>
        <Port>3306</Port>
        <LockMode>Unlock</LockMode>
        <Description>test instance</Description>
        <ConnectionString>pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com</ConnectionString>
        <StorageUsed>17042505728</StorageUsed>
        <ExpireDate>2022-08-31T16:00:00.000+0000</ExpireDate>
        <CommodityCode>drds_polarxpost_public_cn</CommodityCode>
        <MaintainStartTime>06:00</MaintainStartTime>
        <DBInstanceType>ReadWrite</DBInstanceType>
        <DBNodeClass>polarx.x4.large.2e</DBNodeClass>
        <LatestMinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</LatestMinorVersion>
        <MaintainEndTime>06:00</MaintainEndTime>
        <DBType>polarx</DBType>
        <RightsSeparationEnabled>false</RightsSeparationEnabled>
        <VPCId>vpc-xxxxx</VPCId>
        <MinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</MinorVersion>
        <RegionId>cn-hangzhou</RegionId>
        <Network>VPC</Network>
        <DBVersion>5.5</DBVersion>
        <VSwitchId>vsw-********</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <Engine>polarx</Engine>
        <KindCode>18</KindCode>
        <Id>pxc-zkralxpc5d****</Id>
        <DBNodes>
            <ComputeNodeId>pxc-i-********</ComputeNodeId>
            <NodeClass>polarx.x4.large.2e</NodeClass>
            <DataNodeId>pxc-xdb-xxxxxx</DataNodeId>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <Id>pxi-*********</Id>
            <RegionId>cn-hangzhou</RegionId>
        </DBNodes>
        <ConnAddrs>
            <Type>VPC</Type>
            <VSwitchId>vsw-*********</VSwitchId>
            <Port>3306</Port>
            <VPCId>vpc-xxxxxx</VPCId>
            <ConnectionString>polardbx-xxx.aliyuncs.com</ConnectionString>
            <VpcInstanceId>pxc-zkralxpc5d****</VpcInstanceId>
        </ConnAddrs>
        <ReadDBInstances>pxr-*********</ReadDBInstances>
        <ResourceGroupId>rg-*********</ResourceGroupId>
        <TagSet>
            <Key>key2</Key>
            <Value>value2</Value>
        </TagSet>
        <CnNodeCount>2</CnNodeCount>
        <DnNodeCount>2</DnNodeCount>
        <CnNodeClassCode>polarx.x4.xlarge.2e</CnNodeClassCode>
        <DnNodeClassCode>mysql.x8.large.25</DnNodeClassCode>
        <Series>enterprise</Series>
        <LTSVersions>X.X.X.X</LTSVersions>
        <TopologyType>3azones</TopologyType>
        <PrimaryZone>cn-shenzhen-e</PrimaryZone>
        <SecondaryZone>cn-shenzhen-a</SecondaryZone>
        <TertiaryZone>cn-shenzhen-e</TertiaryZone>
    </DBInstance>
</DescribeDBInstanceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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-*********" ],
    "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"
  }
}

Error codes

For a list of error codes, see Service error codes.