调用DescribeDBInstanceAttribute接口获取实例属性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceAttribute

系统规定参数。取值:DescribeDBInstanceAttribute

RegionId String cn-hangzhou

实例所在地域。

DBInstanceName String pxc-********

实例名。

返回数据

名称 类型 示例值 描述
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C

请求ID。

DBInstance Object

数据库实例信息。

Type String ReadWrite

实例类型:

  • ReadWrite: 主实例;
  • ReadOnly: 只读实例。
Status String Running

实例状态,详情请参见实例状态表

RightsSeparationStatus String disabled

三权分立状态:

  • disabled:未开启;
  • enabled:开启;
  • processing: 处理中;
  • unknown:未知,可能是实例无法连接导致。
DBNodeCount Integer 2

实例节点数量。

Expired String false

是否过期:

  • true:过期;
  • false:正常。
CreateTime String 2021-08-31T08:56:25.000+0000

创建时间。

PayType String Postpaid

实例付费方式,取值:

  • Postpaid:按量付费;
  • Prepaid:包年包月。
Port String 3306

内网连接端口。

LockMode String Unlock

实例锁定模式:

  • Unlock:正常;
  • ManualLock:手动触发锁定;
  • LockByExpiration:实例过期自动锁定;
  • LockByRestoration:实例回滚前的自动锁定;
  • LockByDiskQuota:实例空间满自动锁定;
  • LockReadInstanceByDiskQuota:只读实例空间满自动锁定。
Description String test instance

实例描述。

ConnectionString String pxc-sprpx766vo62nh.polarx.singapore.rds.aliyuncs.com

内网连接信息。

StorageUsed Long 17042505728

已经使用的存储。

ExpireDate String 2022-08-31T16:00:00.000+0000

到期时间。格式为yyyy-MM-ddTHH:mm:ss.sss+0000(UTC时间)。

CommodityCode String drds_polarxpost_public_cn

实例商品种类。

MaintainStartTime String 06:00

实例可维护时间段,此处为UTC时间,加8小时才是控制台上显示的可维护时间段。

DBInstanceType String ReadWrite

实例类型:

  • ReadWrite: 主实例;
  • ReadOnly: 只读实例。
DBNodeClass String polarx.x4.large.2e

实例节点规格。

LatestMinorVersion String polarx-kernel_5.4.11-16301083_xcluster-20210805

当前实例支持的最新内核版本。

MaintainEndTime String 06:00

实例可维护时间段,此处为UTC时间,加8小时为控制台上显示的可维护时间段。

DBType String polarx

数据库类型。

RightsSeparationEnabled Boolean false

三权分立状态:

  • false:未开启
  • true:开启
VPCId String vpc-xxxxx

VPC ID。

MinorVersion String polarx-kernel_5.4.11-16301083_xcluster-20210805

当前内核版本。

RegionId String cn-hangzhou

实例所在地域。

Network String VPC

实例的网络类型,取值:

  • Classic:经典网络;
  • VPC:专有网络。
DBVersion String 5.5

数据库版本。

VSwitchId String vsw-xxxxxx

交换机ID。

ZoneId String cn-hangzhou-a

实例所在可用区。

Engine String MySQL

数据库类型。

KindCode Integer 18

实例引擎版本,内部参数。

Id String rm-uf6wjk5xxxxxxxxxx

主实例的ID,如果没有返回此参数则表示该实例是主实例。

DBNodes Array of DBNode

数据库节点信息。

ComputeNodeId String pxc-i-xxxxxx

计算节点名称。

NodeClass String polarx.x4.large.2e

节点规格。

DataNodeId String pxc-xdb-xxxxxx

存储节点名称。

ZoneId String cn-hangzhou-a

节点所在地域名称。

Id String pxi-xxxxxx

逻辑节点ID。

RegionId String cn-hangzhou

节点所在地域ID。

ConnAddrs Array of ConnAddr
Type String VPC

连接的种类,VPC为内网连接,PUBLIC为公网连接。

VSwitchId String vsw-xxxxxx

交换机ID。

Port Long 3306

连接端口号。

VPCId String vpc-xxxxxx

VPC ID。

ConnectionString String polardbx-xxx.aliyuncs.com

连接地址。

ReadDBInstances Array of String pxr-xxxxxx

只读实例名称。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&公共请求参数

正常返回示例

XML格式

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-sprpx766vo62nh.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-xxxxxx</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <Engine>MySQL</Engine>
        <KindCode>18</KindCode>
        <Id>rm-uf6wjk5xxxxxxxxxx</Id>
        <DBNodes>
            <ComputeNodeId>pxc-i-xxxxxx</ComputeNodeId>
            <NodeClass>polarx.x4.large.2e</NodeClass>
            <DataNodeId>pxc-xdb-xxxxxx</DataNodeId>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <Id>pxi-xxxxxx</Id>
            <RegionId>cn-hangzhou</RegionId>
        </DBNodes>
        <ConnAddrs>
            <Type>VPC</Type>
            <VSwitchId>vsw-xxxxxx</VSwitchId>
            <Port>3306</Port>
            <VPCId>vpc-xxxxxx</VPCId>
            <ConnectionString>polardbx-xxx.aliyuncs.com</ConnectionString>
        </ConnAddrs>
        <ReadDBInstances>pxr-xxxxxx</ReadDBInstances>
    </DBInstance>
</DescribeDBInstanceAttributeResponse>

JSON格式

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-sprpx766vo62nh.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-xxxxxx",
    "ZoneId" : "cn-hangzhou-a",
    "Engine" : "MySQL",
    "KindCode" : 18,
    "Id" : "rm-uf6wjk5xxxxxxxxxx",
    "DBNodes" : [ {
      "ComputeNodeId" : "pxc-i-xxxxxx",
      "NodeClass" : "polarx.x4.large.2e",
      "DataNodeId" : "pxc-xdb-xxxxxx",
      "ZoneId" : "cn-hangzhou-a",
      "Id" : "pxi-xxxxxx",
      "RegionId" : "cn-hangzhou"
    } ],
    "ConnAddrs" : [ {
      "Type" : "VPC",
      "VSwitchId" : "vsw-xxxxxx",
      "Port" : 3306,
      "VPCId" : "vpc-xxxxxx",
      "ConnectionString" : "polardbx-xxx.aliyuncs.com"
    } ],
    "ReadDBInstances" : [ "pxr-xxxxxx" ]
  }
}

错误码

访问错误中心查看更多错误码。