DescribeDatabases--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribeDatabases

最近更新时间：2024.12.13 12:00:09首次发布时间：2023.11.15 22:39:51

调用 DescribeDatabases 接口查询数据库列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-ca7b7019****	实例 ID。
DBName	String	否	testdb1	数据库名称。说明不传值或传空值时，会查询指定实例下的所有数据库。
PageNumber	Integer	否	1	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	10	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	1	数据库总数。
Databases	Object[]	请参见返回示例。	数据库列表。

示例

请求示例

POST /?Action=DescribeDatabases&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "postgres-ca7b7019****",
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023080216495355289C8C837799FC33EF",
        "Action": "DescribeDatabases",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "Databases": [
            {
                "CType": "en_US.utf8",
                "CharacterSetName": "utf8",
                "Collate": "en_US.utf8",
                "DBName": "testdb1",
                "DBStatus": "Available",
                "Owner": "pg_rds_superuser"
            }
        ],
        "Total": 1
    }
}