调用DescribeDBInstanceOnECSAttribute接口查询存储弹性模式的AnalyticDB PostgreSQL版实例详情。

使用说明

本接口一般用于查看存储弹性模式的AnalyticDB PostgreSQL版实例的规格、网络类型、实例状态等信息。

QPS限制

本接口的单用户QPS限制为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

请求参数

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

系统规定参数。取值:DescribeDBInstanceOnECSAttribute

DBInstanceId String gp-bp***************

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 5850BF81-1A2B-5ACE-AF41-57**********

请求ID。

Items Array of DBInstanceAttribute

实例详情列表。

DBInstanceAttribute
CreationTime String 2021-09-15T08:30:00Z

实例创建时间。

VpcId String vpc-bp*******************

VPC ID。

EncryptionType String CloudDisk

云盘加密类型,可选项为:

  • NULL:不启用加密(默认值)。
  • CloudDisk:云盘加密并通过EncryptionKey参数指定密钥。
注意 当前云盘加密开启后无法关闭。
InstanceDeployType String cluster

实例版本类型:

  • cluster:存储弹性模式。
PayType String Prepaid

计费类型:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
Tags Array of Tag

实例标签。

Tag
Key String test-key

标签键。

Value String test-value

标签值。

StorageType String cloud_essd

实例存储类型,取值如下:

  • cloud_essd:ESSD云盘
  • cloud_efficiency:高效云盘
ConnectionMode String LVS

访问模式,模式如下:

  • LVS:LVS链路模式
  • Standard:标准访问模式
  • Safty:高安全访问模式
Port String 5432

实例的端口号。

LockMode String Unlock

实例锁定模式,状态如下:

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

数据库版本。

MemorySize Integer 16

单Segment节点内存容量,单位GB。

SegNodeNum Integer 4

Segment节点数量。

ConnectionString String gp-bp***************-master.gpdb.rds.aliyuncs.com

实例连接地址。

InstanceNetworkType String VPC

实例网络类型,取值如下:

  • Classic:经典网络
  • VPC:VPC网络
EncryptionKey String 9fc356bf-b59c-42e0-9659-************

加密的密钥ID。如果未启用云盘加密则为空。

DBInstanceDescription String gp-bp***************

实例描述。

CpuCores Integer 2

单Segment节点的CPU核数。

ExpireTime String 2021-10-15T16:00:00Z

实例到期时间。

DBInstanceStatus String Running

实例状态,详见实例状态表

StorageSize Integer 50

存储空间大小,单位GB。

RegionId String cn-hangzhou

地域ID。

VSwitchId String vsw-bp*******************

vSwitch ID。

ZoneId String cn-hangzhou-h

可用区ID。

DBInstanceId String gp-bp***************

实例ID。

Engine String gpdb

数据库引擎。

DBInstanceClass String adbpg.cluster.eni.2c16g

实例规格。

SupportRestore Boolean true

是否支持备份恢复。

  • true:支持备份恢复
  • false:不支持备份恢复
MinorVersion String 6.3.4.10-202109231235

AnalyticDB PostgreSQL版实例的版本号。

MasterNodeNum Integer 1

Master节点数量。

DBInstanceCategory String HighAvailability

AnalyticDB PostgreSQL版的实例系列。取值如下:

  • Basic:基础版
  • HighAvailability:高可用版

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeDBInstanceOnECSAttribute
&DBInstanceId=gp-bp***************
&<公共请求参数>

正常返回示例

XML格式

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

<DescribeDBInstanceOnECSAttributeResponse>
    <RequestId>5850BF81-1A2B-5ACE-AF41-57**********</RequestId>
    <Items>
        <DBInstanceAttribute>
            <MasterNodeNum>1</MasterNodeNum>
            <Port>5432</Port>
            <SegNodeNum>4</SegNodeNum>
            <EncryptionKey>9fc356bf-b59c-42e0-9659-************</EncryptionKey>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <SupportRestore>true</SupportRestore>
            <DBInstanceCategory>HighAvailability</DBInstanceCategory>
            <DBInstanceId>gp-bp***************</DBInstanceId>
            <DBInstanceDescription>gp-bp***************</DBInstanceDescription>
            <Engine>gpdb</Engine>
            <Tags>
                <Tag>
                    <Value>test-value</Value>
                    <Key>test-key</Key>
                </Tag>
            </Tags>
            <MemorySize>16</MemorySize>
            <EncryptionType>CloudDisk</EncryptionType>
            <StorageType>cloud_essd</StorageType>
            <EngineVersion>6.0</EngineVersion>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceClass>adbpg.cluster.eni.2c16g</DBInstanceClass>
            <VSwitchId>vsw-bp*******************</VSwitchId>
            <StorageSize>50</StorageSize>
            <MinorVersion>6.3.4.10-202109231235</MinorVersion>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <VpcId>vpc-bp*******************</VpcId>
            <CreationTime>2021-09-15T08:30:00Z</CreationTime>
            <InstanceDeployType>cluster</InstanceDeployType>
            <ConnectionMode>LVS</ConnectionMode>
            <CpuCores>2</CpuCores>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>gp-bp***************-master.gpdb.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-10-15T16:00:00Z</ExpireTime>
        </DBInstanceAttribute>
    </Items>
</DescribeDBInstanceOnECSAttributeResponse>

JSON格式

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

{
  "RequestId" : "5850BF81-1A2B-5ACE-AF41-57**********",
  "Items" : {
    "DBInstanceAttribute" : [ {
      "MasterNodeNum" : 1,
      "Port" : "5432",
      "SegNodeNum" : 4,
      "EncryptionKey" : "9fc356bf-b59c-42e0-9659-************",
      "InstanceNetworkType" : "VPC",
      "SupportRestore" : true,
      "DBInstanceCategory" : "HighAvailability",
      "DBInstanceId" : "gp-bp***************",
      "DBInstanceDescription" : "gp-bp***************",
      "Engine" : "gpdb",
      "Tags" : {
        "Tag" : [ {
          "Value" : "test-value",
          "Key" : "test-key"
        } ]
      },
      "MemorySize" : 16,
      "EncryptionType" : "CloudDisk",
      "StorageType" : "cloud_essd",
      "EngineVersion" : "6.0",
      "DBInstanceStatus" : "Running",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceClass" : "adbpg.cluster.eni.2c16g",
      "VSwitchId" : "vsw-bp*******************",
      "StorageSize" : 50,
      "MinorVersion" : "6.3.4.10-202109231235",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "VpcId" : "vpc-bp*******************",
      "CreationTime" : "2021-09-15T08:30:00Z",
      "InstanceDeployType" : "cluster",
      "ConnectionMode" : "LVS",
      "CpuCores" : 2,
      "RegionId" : "cn-hangzhou",
      "ConnectionString" : "gp-bp***************-master.gpdb.rds.aliyuncs.com",
      "ExpireTime" : "2021-10-15T16:00:00Z"
    } ]
  }
}

错误码

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