文档

DescribeDBInstanceAttribute - 查询实例详情

更新时间:

查询AnalyticDB PostgreSQL版实例详情。

接口说明

使用说明

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

QPS 限制

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

本文档中的 QPS 仅为默认参考值,准确信息请参见 API 速率配额列表

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDBInstanceAttributeRead
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

该参数已废弃,无需传入该参数。

null
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
gp-bp13ue79qk8y1****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68
Itemsobject []

实例详情列表。

VpcIdstring

VPC ID。

vpc-bp19ame5m1r3oejns****
CreationTimestring

实例创建时间。

2022-08-11T09:16:26Z
DBInstanceCpuCoresinteger

CPU 核数。

2
SegmentCountsinteger

计算组个数。

说明 该参数仅适用存储预留模式的实例。
0
StoragePerNodeinteger

单副本的存储大小,单位请参见 StorageUnit 参数。

说明 该参数仅适用存储预留模式的实例。
0
DBInstanceMemorylong

计算节点的内存。

说明 存储预留模式的单位为 MB;Serverless 和存储弹性模式单位为 GB。
16
HostTypestring

计算组机器类型,取值说明:

  • 0:SSD
  • 1:HDD
说明 该参数仅适用存储预留模式的实例。
0
PayTypestring

计费类型,取值说明:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
Postpaid
Tagsobject []

标记键值对。

Keystring

标签键。

test-key
Valuestring

标签值。

test-value
StorageTypestring

存储类型,取值说明:

  • cloud_essd:ESSD 云盘。
  • cloud_efficiency:高效云盘。
说明 该参数仅适用存储弹性模式的实例。
cloud_essd
AvailabilityValuestring

查询当前实例可用性状态,单位:百分比(%)。

说明 该参数仅适用存储预留模式的实例。
100.0%
ReadDelayTimestring

该参数已废弃,故不会返回参数值。

null
CpuCoresPerNodeinteger

单节点的 CPU 核数。

说明 该参数仅适用存储预留模式的实例。
0
Portstring

实例的端口号。

5432
ConnectionModestring

访问模式,取值说明:

  • Performance:标准访问模式。
  • Safty:高安全访问模式。
  • LVS:LVS 链路模式。
LVS
LockModestring

锁定方式,取值说明:

  • Unlock:正常 。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前的自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
Unlock
EngineVersionstring

数据库版本。

6.0
StorageUnitstring

存储单位,取值说明:

  • GB SSD
  • TB SSD
  • GB HDD
说明 该参数仅适用存储预留模式的实例。
GB SSD
MemoryPerNodeinteger

单副本的内存大小,单位请参见 MemoryUnit 参数。

说明 该参数仅适用存储预留模式的实例。
0
ConnectionStringstring

实例连接地址。

gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
InstanceNetworkTypestring

实例网络类型,取值说明:

  • Classic:经典网络。
  • VPC:VPC 网络。
VPC
SecurityIPListstring

该参数已废弃,不会返回参数值。

null
MemoryUnitstring

内存单位。

说明 该参数仅适用存储预留模式的实例。
GB
DBInstanceClassTypestring

实例规格族,取值说明:

  • s:共享型。
  • x:通用型。
  • d:独享套餐。
  • h:独占物理机。
x
DBInstanceDescriptionstring

实例描述。

gp-bp13ue79qk8y1****
DBInstanceGroupCountstring

计算组数量。

说明 该参数仅适用存储预留模式的实例。
0
ExpireTimestring

实例到期时间(UTC 时间)。

说明 按量付费实例的到期时间为2999-09-08T16:00:00Z
2999-09-08T16:00:00Z
DBInstanceNetTypestring

该参数已废弃,不会返回参数值。

null
MaintainStartTimestring

可维护开始时间。

18:00Z
MaintainEndTimestring

可维护结束时间。

22:00Z
LockReasonstring

该参数已废弃,故不会返回参数值。

null
DBInstanceStatusstring

实例状态,详细说明请参见 DBInstanceStatus 参数补充说明。

Running
RegionIdstring

地域 ID。

cn-hangzhou
DBInstanceDiskMBPSlong

计算组最大的 BPS(磁盘吞吐量),单位:Mbps。

说明 该参数仅适用存储预留模式的实例。
0
DBInstanceStoragelong

单个副本的最大存储空间,单位:GB。

50
ZoneIdstring

可用区 ID。

cn-hangzhou-j
MaxConnectionsinteger

实例的最大并发连接数。

说明 该参数仅适用存储预留模式的实例。
500
DBInstanceIdstring

实例 ID。

gp-bp13ue79qk8y1****
DBInstanceClassstring

实例规格。

说明 该参数仅适用存储预留模式的实例。
gpdb.group.segsdx1
Enginestring

数据库引擎。

gpdb
DBInstanceCategorystring

实例系列,取值说明:

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

计算节点 CPU 核数,单位 Core。

2
MemorySizelong

计算节点内存大小。

说明 存储预留模式的单位为 MB;Serverless 和存储弹性模式单位为 GB。
16
StorageSizelong

存储空间大小,单位 GB。

50
SegNodeNuminteger

Segment 节点数量。

说明 该参数仅适用存储弹性模式和 Serverless 手动调度模式的实例。
4
MasterNodeNuminteger

Master 节点数量。

1
DBInstanceModestring

实例资源类型,取值说明:

  • Serverless:Serverless 模式。
  • StorageElastic:存储弹性模式。
  • Classic:存储预留模式。
StorageElastic
MinorVersionstring

内核小版本。

6.3.10.1-202207141918
SupportRestoreboolean

是否支持备份恢复,取值说明:

  • true:支持备份恢复。
  • false:不支持备份恢复。
true
VSwitchIdstring

vSwitch ID。

vsw-bp1cpq8mr64paltkb****
EncryptionKeystring

加密密钥。

说明 仅开启云盘加密的实例会返回该参数。
0d2470df-da7b-4786-b981-************
EncryptionTypestring

加密类型,取值说明:

  • CloudDisk:云盘加密。
说明 仅云盘加密的实例会返回该参数。
CloudDisk
CoreVersionstring

内核小版本号。

mm.v6.3.10.1-202207141918
RunningTimestring

实例运行时长。

4 days 22:58:55
StartTimestring

实例开始运行的时间。

2022-08-11T09:26:43Z
ResourceGroupIdstring

实例所在的资源组 ID。

rg-bp67acfmxazb4p****
ServerlessResourceinteger

计算资源阈值。单位为 ACU。

说明 仅 Serverless 自动调度模式实例返回该参数。
32
IdleTimeinteger

空闲释放等待时长。单位为秒。

说明 仅 Serverless 自动调度模式实例返回该参数。
600
ServerlessModestring

Serverless 实例的模式,取值如下:

  • Manual:手动调度。
  • Auto:自动调度。
说明 仅 Serverless 模式实例返回该参数。
Auto
SegDiskPerformanceLevelstring

性能级别 PL(Performance Level),目前仅支持 PL1

PL1
VectorConfigurationStatusstring

是否开启向量引擎优化,取值说明:

  • enabled:表示开启向量引擎优化。
  • disabled:表示已关闭向量引擎优化。
enabled
MasterCUinteger

Master 资源。

4

DBInstanceStatus 参数补充说明

DBInstanceStatus 取值如下:

  • Creating:创建中。
  • Running:使用中。
  • Deleting:删除中。
  • Rebooting:重启中。
  • DBInstanceClassChanging:升降级中。
  • Transfering:迁移中。
  • EngineVersionUpgrading:迁移版本中。
  • TransferingToOtherInstance:迁移数据到其他 AnalyticDB for PostgreSQL 中。
  • GuardDBInstanceCreating:创建灾备实例中。
  • Restoring:备份恢复中。
  • Importing:数据导入中。
  • ImportingFromOtherInstance:从其他 AnalyticDB for PostgreSQL 实例导入数据中。
  • DBInstanceNetTypeChangin:内外网切换中。
  • GuardSwitching:容灾切换中。

示例

正常返回示例

JSON格式

{
  "RequestId": "5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "CreationTime": "2022-08-11T09:16:26Z",
        "DBInstanceCpuCores": 2,
        "SegmentCounts": 0,
        "StoragePerNode": 0,
        "DBInstanceMemory": 16,
        "HostType": "0",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "StorageType": "cloud_essd",
        "AvailabilityValue": "100.0%",
        "ReadDelayTime": "null",
        "CpuCoresPerNode": 0,
        "Port": "5432",
        "ConnectionMode": "LVS",
        "LockMode": "Unlock",
        "EngineVersion": "6.0",
        "StorageUnit": "GB SSD",
        "MemoryPerNode": 0,
        "ConnectionString": "gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com",
        "InstanceNetworkType": "VPC",
        "SecurityIPList": "null",
        "MemoryUnit": "GB",
        "DBInstanceClassType": "x",
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceGroupCount": "0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBInstanceNetType": "null",
        "MaintainStartTime": "18:00Z",
        "MaintainEndTime": "22:00Z",
        "LockReason": "null",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceDiskMBPS": 0,
        "DBInstanceStorage": 50,
        "ZoneId": "cn-hangzhou-j",
        "MaxConnections": 500,
        "DBInstanceId": "gp-bp13ue79qk8y1****",
        "DBInstanceClass": "gpdb.group.segsdx1",
        "Engine": "gpdb",
        "DBInstanceCategory": "HighAvailability",
        "CpuCores": 2,
        "MemorySize": 16,
        "StorageSize": 50,
        "SegNodeNum": 4,
        "MasterNodeNum": 1,
        "DBInstanceMode": "StorageElastic",
        "MinorVersion": "6.3.10.1-202207141918",
        "SupportRestore": true,
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "EncryptionKey": "0d2470df-da7b-4786-b981-************",
        "EncryptionType": "CloudDisk",
        "CoreVersion": "mm.v6.3.10.1-202207141918",
        "RunningTime": "4 days 22:58:55",
        "StartTime": "2022-08-11T09:26:43Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ServerlessResource": 32,
        "IdleTime": 600,
        "ServerlessMode": "Auto",
        "SegDiskPerformanceLevel": "PL1",
        "VectorConfigurationStatus": "enabled",
        "MasterCU": 4,
        "ProdType": ""
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈