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

By | 2021年4月22日
0 Comment

调用DescribeDBInstances接口查看实例列表详情。

调试

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

请求参数

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

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

RegionId String 是 ch-hangzhou

实例所属地域。
PageNumber Integer 否 1

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

PageSize Integer 否 30

每页记录数，取值为30、50或100。

默认值为30。

ResourceGroupId String 否 -1

资源组ID。

返回数据

名称 类型 示例值 描述
DBInstances Array of DBInstance

实例信息。
CommodityCode String drds_polarxpre_public_cn

商品ID，取值范围如下：

  • drds_polarxpre_public_cn（包年包月即预付费实例）
  • drds_polarxpost_public_cn（按量付费即后付费实例）
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年7月29日上午6时9分30秒。

DBType String polarx

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

DBVersion String 5.7

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

Description String test

实例描述信息。
Engine String polarx

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

ExpireTime 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 Boolean false

实例是否已到期。

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

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

实例ID。
LockMode String Unlock

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

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

LockReason String ****

实例被锁定的原因。

说明 仅当实例处于锁定状态时返回该参数。

Network String VPC

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

NodeClass String polarx.x4.large.2d

实例的节点规格。
NodeCount Integer 2

实例的节点数量。
PayType String Prepaid

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

  • Postpaid：按量付费（即后付费）
  • Prepaid：包年包月（即预付费）
说明 关于付费类型，详情请参见
产品定价。

RegionId String cn-hangzhou

实例所在地域。
Status String Running

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

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

实例的磁盘使用量，单位为Byte。
VPCId String vpc-*********************

VPC ID。
ZoneId String cn-hangzhou-h

实例所在的可用区ID。
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秒到期。

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

PageNumber Integer 1

页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。

PageSize Integer 30

每页记录数，取值为30、50或100。

默认值为30。

RequestId String 91EA81C3-1622-47BF-BDCC-0D7BA1******

请求ID。

示例

请求示例

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

正常返回示例

XML 格式 

<code>200</code>
<data>
    <RequestId>91EA81C3-1622-47BF-BDCC-0D7BA1******</RequestId>
    <PageSize>2</PageSize>
    <PageNumber>1</PageNumber>
    <DBInstances>
        <Status>Running</Status>
        <Description/>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <NodeCount>2</NodeCount>
        <VPCId>vpc-*********************</VPCId>
        <CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
        <Expired>false</Expired>
        <PayType>Prepaid</PayType>
        <DBType>polarx</DBType>
        <LockMode>Unlock</LockMode>
        <StorageUsed>6784286720</StorageUsed>
        <NodeClass>polarx.x4.large.2d</NodeClass>
        <DBVersion>5.7</DBVersion>
        <Network>VPC</Network>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <Id>pxc-****************</Id>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
        <Engine>polarx</Engine>
    </DBInstances>
    <DBInstances>
        <Status>Running</Status>
        <Description>2test</Description>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <NodeCount>2</NodeCount>
        <VPCId>vpc-*********************</VPCId>
        <CreateTime>2020-07-29T06:09:30.000+0800</CreateTime>
        <Expired>false</Expired>
        <PayType>Prepaid</PayType>
        <DBType>polarx</DBType>
        <LockMode>Unlock</LockMode>
        <StorageUsed>6834618368</StorageUsed>
        <NodeClass>polarx.x4.large.2d</NodeClass>
        <DBVersion>5.7</DBVersion>
        <Network>VPC</Network>
        <CommodityCode>drds_polarxpre_public_cn</CommodityCode>
        <Id>pxc-****************</Id>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2020-08-29T06:09:30.000+0800</ExpireTime>
        <Engine>polarx</Engine>
    </DBInstances>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>91EA81C3-1622-47BF-BDCC-0D7BA1******</requestId>
<successResponse>true</successResponse>

JSON 格式 

{
	"code": "200",
	"data": {
		"RequestId": "91EA81C3-1622-47BF-BDCC-0D7BA1******",
		"PageSize": 2,
		"PageNumber": 1,
		"DBInstances": [{
			"Status": "Running",
			"Description": "",
			"ZoneId": "cn-hangzhou-h",
			"NodeCount": 2,
			"VPCId": "vpc-*********************",
			"CreateTime": "2020-07-29T06:09:30.000+0800",
			"Expired": false,
			"PayType": "Prepaid",
			"DBType": "polarx",
			"LockMode": "Unlock",
			"StorageUsed": 6784286720,
			"NodeClass": "polarx.x4.large.2d",
			"DBVersion": "5.7",
			"Network": "VPC",
			"CommodityCode": "drds_polarxpre_public_cn",
			"Id": "pxc-****************",
			"RegionId": "cn-hangzhou",
			"ExpireTime": "2020-08-29T06:09:30.000+0800",
			"Engine": "polarx"
		}, {
			"Status": "Running",
			"Description": "2test",
			"ZoneId": "cn-hangzhou-h",
			"NodeCount": 2,
			"VPCId": "vpc-*********************",
			"CreateTime": "2020-07-29T06:09:30.000+0800",
			"Expired": false,
			"PayType": "Prepaid",
			"DBType": "polarx",
			"LockMode": "Unlock",
			"StorageUsed": 6834618368,
			"NodeClass": "polarx.x4.large.2d",
			"DBVersion": "5.7",
			"Network": "VPC",
			"CommodityCode": "drds_polarxpre_public_cn",
			"Id": "pxc-****************",
			"RegionId": "cn-hangzhou",
			"ExpireTime": "2020-08-29T06:09:30.000+0800",
			"Engine": "polarx"
		}]
	},
	"httpStatusCode": "200",
	"requestId": "91EA81C3-1622-47BF-BDCC-0D7BA1******",
	"successResponse": true
}

错误码

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

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

发表回复

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

Iconic One Theme | Powered by Wordpress