查询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:DescribeDBInstanceAttribute | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ResourceGroupId | string | 否 | 该参数已废弃，无需传入该参数。 | null |
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
| gp-bp13ue79qk8y1**** |
返回参数
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": "standard",
"DeployMode": "single",
"StandbyZoneId": "cn-hangzhou-i"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-11 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-01-04 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-23 | OpenAPI 返回结构发生变更 | 查看变更详情 |