查询实例详情

最近更新时间:2018-09-18 17:03:18

1. 接口描述

接口请求域名: postgres.tencentcloudapi.com 。

本接口 (DescribeDBInstanceAttribute) 用于查询某个实例的详情信息。

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:postgres.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceAttribute
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DBInstanceId String 实例ID

3. 输出参数

参数名称 类型 描述
DBInstance DBInstance 实例详细信息。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查询实例的详细信息

输入示例

https://postgres.tencentcloudapi.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=postgres-6bwgamo3
&<公共请求参数>

输出示例

{
  "Response": {
    "DBInstance": {
      "AppId": 100000000,
      "AutoRenew": false,
      "CreateTime": "2017-12-28 19:23:19",
      "DBCharset": "UTF8",
      "DBInstanceClass": "cdb.pg.z1.4g",
      "DBInstanceCpu": 2,
      "DBInstanceId": "postgres-6bwgamo3",
      "DBInstanceMemory": 4,
      "DBInstanceName": "未命名",
      "DBInstanceNetInfo": [
        {
          "Address": "",
          "Ip": "xxxxx",
          "NetType": "inner",
          "Port": 5432,
          "Status": "opened"
        },
        {
          "Address": "",
          "Ip": "",
          "NetType": "public",
          "Port": 0,
          "Status": "0"
        }
      ],
      "DBInstanceStatus": "running",
      "DBInstanceStorage": 20,
      "DBInstanceType": "primary",
      "DBInstanceVersion": "standard",
      "DBVersion": "9.5.4",
      "ExpireTime": "2018-01-28 19:23:23",
      "IsolatedTime": "0000-00-00 00:00:00",
      "PayType": "prepaid",
      "ProjectId": 0,
      "Region": "ap-guangzhou",
      "SubnetId": "",
      "UpdateTime": "2018-01-18 15:54:32",
      "VpcId": "",
      "Zone": "ap-guangzhou-2"
    },
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.DBError 后台DB执行错误。
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InternalError.UnknownError 其他未知错误。出现这种错误时,请联系客服支持。