PolarDB-X 云原生分布式数据库 DescribeDBInstanceAttribute

By | 2021年4月22日
0 Comment

调用DescribeDBInstanceAttribute接口查看实例属性详情。

调试

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

请求参数

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

系统规定参数。取值为DescribeDBInstanceAttribute。

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

实例ID。
RegionId String 是 cn-hangzhou

实例所在地域。

返回数据

名称 类型 示例值 描述
DBInstance Struct

实例信息。
CommodityCode String drds_polarxpre_public_cn

商品ID，取值范围如下：

  • drds_polarxpre_public_cn（包年包月即预付费实例）
  • drds_polarxpost_public_cn（按量付费即后付费实例）
ConnAddrs Array of ConnAddr

实例连接信息。
ConnectionString String pxc-****************.polarx.rds.aliyuncs.com

VPC连接地址。
Port String 3306

VPC端口号。
Type String VPC

网络类型，目前仅支持专有网络VPC。
VPCId String vpc-*******************

VPC ID。
VSwitchId String vsw-*********************

VPC的虚拟交换机ID。
ConnectionString String pxc-****************.polarx.rds.aliyuncs.com

实例的主要连接地址。
CreateTime String 2020-07-29T06:09:30.000+0800

实例创建时间，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2020-07-29T06:09:30.000+0800表示该实例于北京时间（UTC+8）2020年8月29日上午6时9分30秒过期

DBInstanceType String ReadWrite

实例类型。取值范围如下：

  • ReadWrite：主实例
  • ReadOnly：只读实例
DBNodeClass String polarx.x4.large.2d

实例节点规格。
DBNodeCount Integer 2

实例节点数量。
DBNodes Array of DBNode

节点信息。
Id String pxi-***************

节点ID。
NodeClass String polarx.x4.large.2d

节点规格。
RegionId String cn-hangzhou

节点所在地域。
ZoneId String cn-hangzhou-h-aliyun

节点所在的可用区。
DBType String polarx

实例的数据库类型，取值固定为polarx。

DBVersion String 5.7

数据库的MySQL版本号，目前仅支持5.7版本。

Description String test

实例描述信息。
Engine String polarx

实例的数据库类型，取值固定为polarx。

ExpireDate String 2020-08-29T06:09:30.000+0800

实例到期时间，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2020-08-29T06:09:30.000+0800表示该实例创建于北京时间（UTC+8）2020年8月29日上午6时9分30秒。

说明 仅包年包月实例支持该参数。

Expired String false

实例是否已到期。

说明 仅包年包月实例支持该参数。

Id String pxc-****************

实例ID。
LatestMinorVersion String polarx-kernel-5.4.5-15941979-xdb-20200125

目标实例内核小版本的最新版本。
LockMode String Unlock

实例的锁定状态，取值范围如下：

  • Unlock（正常）
  • LockByExpiration（实例过期时自动锁定）。
说明 当您的实例时欠费会触发锁定，建议您在阿里云账号下预留足够的费用或在实例欠费前及时续费，避免出现因欠费导致实例锁定影响正常业务。

关于如何续费，详情请参见实例续费。

MaintainEndTime String 06:00

实例可维护时间的终止时间。
MaintainStartTime String 02:00

实例可维护时间的起始时间。
MinorVersion String polarx-kernel-5.4.5-15941979-xdb-20200125

目标实例当前的内核小版本。
Network String VPC

实例的网络类型，目前仅支持VPC（专有网络）。

PayType String Prepaid

付费类型，取值范围如下：

  • Postpaid：按量付费（即后付费）
  • Prepaid：包年包月（即预付费）

关于付费类型，详情请参见产品定价。

Port String 3306

实例主要连接地址所使用的端口号。
ReadDBInstances List ["pxc-****************", "pxc-****************"]

只读实例名称列表。
RegionId String cn-hangzhou

实例所在的地域。
Status String Running

实例的状态，取值范围如下：

  • Creating：创建中
  • Running：运行中
  • Deleting：释放中
  • MinorVersionUpgrading：正在升级版本
  • ClassChanging：正在变更节点规格
  • NodeCreating（scale out）：正在增加节点
  • NodeDeleting（scale in）正在删除节点
StorageUsed String 6781140992

实例的磁盘使用量，单位为Byte。
Type String ReadWrite

实例类型，取值范围如下：

  • ReadWrite：主实例
  • ReadOnly：只读实例
VPCId String vpc-*******************

VPC ID。
VSwitchId String vsw-*********************

VPC的虚拟交换机ID。
ZoneId String cn-hangzhou-h

实例所在的可用区
RequestId String 7307D0CA-E315-4D51-8D36-F83767******

请求ID。

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceName=pxc-****************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<DescribeDBInstanceAttributeResponse>
  <RequestId>7307D0CA-E315-4D51-8D36-F83767******</RequestId>
  <DBInstance>
        <Description>test</Description>
        <ExpireDate>2020-08-29T06:09:30.000+0800</ExpireDate>
        <ReadDBInstances>["pxc-****************", "pxc-****************"]</ReadDBInstances>
        <ConnAddrs>
              <Type>VPC</Type>
              <ConnectionString>pxc-****************.polarx.rds.aliyuncs.com</ConnectionString>
              <VPCId>vpc-*******************</VPCId>
              <VSwitchId>vsw-*********************</VSwitchId>
              <Port>3306</Port>
        </ConnAddrs>
        <Port>3306</Port>
        <DBInstanceType>ReadWrite</DBInstanceType>
        <DBType>polarx</DBType>
        <DBVersion>5.7</DBVersion>
        <MaintainEndTime>06:00</MaintainEndTime>
        <DBNodes>
              <NodeClass>polarx.x4.large.2d</NodeClass>
              <RegionId>cn-hangzhou</RegionId>
              <Id>pxi-***************</Id>
              <ZoneId>cn-hangzhou-h-aliyun</ZoneId>
        </DBNodes>
        <Network>VPC</Network>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <DBNodeCount>2</DBNodeCount>
        <MaintainStartTime>02:00</MaintainStartTime>
        <Engine>polarx</Engine>
        <Status>Running</Status>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <VPCId>vpc-*******************</VPCId>
        <VSwitchId>vsw-*********************</VSwitchId>
        <CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
        <MinorVersion>polarx-kernel-5.4.5-15941979-xdb-20200125</MinorVersion>
        <LatestMinorVersion>polarx-kernel-5.4.5-15941979-xdb-20200125</LatestMinorVersion>
        <Expired>false</Expired>
        <LockMode>Unlock</LockMode>
        <PayType>Prepaid</PayType>
        <DBNodeClass>polarx.x4.large.2d</DBNodeClass>
        <StorageUsed>6781140992</StorageUsed>
        <Type>ReadWrite</Type>
        <Id>pxc-****************</Id>
        <RegionId>cn-hangzhou</RegionId>
        <ConnectionString>pxc-****************.polarx.rds.aliyuncs.com</ConnectionString>
  </DBInstance>
</DescribeDBInstanceAttributeResponse>

JSON格式 

{
    "RequestId": "7307D0CA-E315-4D51-8D36-F83767******",
    "DBInstance": {
        "Description": "test",
        "ExpireDate": "2020-08-29T06:09:30.000+0800",
        "ReadDBInstances": "[\"pxc-****************\", \"pxc-****************\"]",
        "ConnAddrs": {
            "Type": "VPC",
            "ConnectionString": "pxc-****************.polarx.rds.aliyuncs.com",
            "VPCId": "vpc-*******************",
            "VSwitchId": "vsw-*********************",
            "Port": 3306
        },
        "Port": 3306,
        "DBInstanceType": "ReadWrite",
        "DBType": "polarx",
        "DBVersion": 5.7,
        "MaintainEndTime": "06:00",
        "DBNodes": {
            "NodeClass": "polarx.x4.large.2d",
            "RegionId": "cn-hangzhou",
            "Id": "pxi-***************",
            "ZoneId": "cn-hangzhou-h-aliyun"
        },
        "Network": "VPC",
        "CommodityCode": "drds_polarxpre_public_cn",
        "DBNodeCount": 2,
        "MaintainStartTime": "02:00",
        "Engine": "polarx",
        "Status": "Running",
        "ZoneId": "cn-hangzhou-h",
        "VPCId": "vpc-*******************",
        "VSwitchId": "vsw-*********************",
        "CreateTime": "2020-07-29T06:09:30.000+0800",
        "MinorVersion": "polarx-kernel-5.4.5-15941979-xdb-20200125",
        "LatestMinorVersion": "polarx-kernel-5.4.5-15941979-xdb-20200125",
        "Expired": false,
        "LockMode": "Unlock",
        "PayType": "Prepaid",
        "DBNodeClass": "polarx.x4.large.2d",
        "StorageUsed": 6781140992,
        "Type": "ReadWrite",
        "Id": "pxc-****************",
        "RegionId": "cn-hangzhou",
        "ConnectionString": "pxc-****************.polarx.rds.aliyuncs.com"
    }
}

错误码

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

请关注公众号获取更多资料

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress