You need to enable JavaScript to run this app.
导航
云数据库 PostgreSQL 版
  • 文档首页
    • /
  • 云数据库 PostgreSQL 版

DescribeDBInstances

最近更新时间：2023.12.08 22:51:47

首次发布时间：2023.11.15 22:39:52

我的收藏

调用 DescribeDBInstances 接口查询实例列表。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString否postgres-21a3333b****实例 ID。
InstanceNameString否测试实例实例名称。

InstanceStatus

String

否

Running

实例状态，取值：

  • Running：运行中。
  • Creating：创建中。
  • Deleting：删除中。
  • Restarting：重启中。
  • Restoring：恢复中。
  • Updating：变更中。
  • Upgrading：升级中。
  • Error：错误。
  • Released：已释放。
  • CreateError：创建错误。
  • MasterChanging：主节点切换中。
  • Deleted：已删除。
  • Recycled：已回收。

DBEngineVersion

String

否

PostgreSQL_12

兼容版本。取值：

  • PostgreSQL_11：PostgreSQL 11。
  • PostgreSQL_12：PostgreSQL 12。
  • PostgreSQL_13：PostgreSQL 13。
CreateTimeStartString否2022-01-01T10:10:10.000Z查询创建实例创建时间范围。
CreateTimeEndString否2022-01-01T10:10:10.000Z查询创建实例创建时间范围。
ZoneIdString否cn-beijing-a实例所属可用区。

ChargeType

String

否

PostPaid

付费类型。取值：

  • PostPaid：按量付费。
  • PrePaid：包年包月。
ProjectNameString否testProject项目名称。
TagFiltersArray of TagFilterObject否请参见请求示例。标签查询数组对象。单次最多支持同时传入 10 组标签键值对进行查询筛选。关于 TagFilterObject 的更多详情，请参见数据结构。
PageNumberInteger否1当前页查询偏移量，默认值为 1。
PageSizeInteger否10每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

名称类型示例值描述
TotalInteger1实例总数。
InstancesArray of InstanceObject请参见返回示例。实例列表，关于 Instances 的详细信息，请参见数据结构。

请求示例

POST /?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****

{
    "PageSize": 10,
    "PageNumber": 1,
    "ChargeType": "PostPaid",
    "InstanceStatus": "Running",
    "CreateTimeStart": "2023-07-24T09:05:36.000Z",
    "TagFilters": [
        {
            "Key": "project",
            "Value": "default"
        }
    ]
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308011748015BF1419EEFC7937C6B6E",
        "Action": "DescribeDBInstances",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Instances": [
            {
                "AddressObject": [
                    {
                        "DNSVisibility": false,
                        "Domain": "postgresca7b7019****.rds-pg.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.253",
                        "NetworkType": "Private",
                        "Port": "5432",
                        "SubnetId": "subnet-30uhx4w39n75s7r2qr0lq****"
                    }
                ],
                "ChargeDetail": {
                    "AutoRenew": false,
                    "ChargeEndTime": "",
                    "ChargeStartTime": "2023-08-01T09:05:29.000Z",
                    "ChargeStatus": "Normal",
                    "ChargeType": "PostPaid",
                    "Number": 1,
                    "OverdueReclaimTime": "",
                    "OverdueTime": "",
                    "Period": 0,
                    "PeriodUnit": "Month", 
                    "TempModifyEndTime": "2023-12-10T12:04:05.000Z", 
                    "TempModifyStartTime": "2023-12-05T12:04:05.000Z"
                },
                "CreateTime": "2023-08-01T09:05:29.000Z",
                "DBEngineVersion": "PostgreSQL_12",
                "InstanceId": "postgres-ca7b7019****",
                "InstanceName": "test123",
                "InstanceStatus": "Running",
                "InstanceType": "HA",
                "NodeNumber": 2,
                "NodeSpec": "rds.postgres.1c2g",
                "ProjectName": "default",
                "RegionId": "cn-beijing",
                "StorageSpace": 20,
                "StorageType": "LocalSSD",
                "SubnetId": "subnet-30uhx4w39n75s7r2qr0lq****",
                "Tags": [
                    {
                        "Key": "project",
                        "Value": "default"
                    }
                ],
                "VpcId": "vpc-2gdgzrrl5icjk50ztyz6b****",
                "ZoneId": "cn-beijing-a",
                "ZoneIds": [
                    "cn-beijing-a"
                ]
            }
        ],
        "Total": 1
    }
}