全部产品
Search
文档中心

云原生数据仓库AnalyticDB:ListDatabases - 查看数据库列表

更新时间:Dec 20, 2024

查看数据库列表。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
RegionIdstring

实例所在 Region ID。

cn-beijing
SecretArnstring

访问凭证。通过 CreateSecret 接口创建。

说明 通过子账号访问此接口时,需要有对此 SecretArn 的 UseSecret 或 GetSecretValue 的权限。
acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
Databasestring

数据库名称。

testdb
MaxResultsinteger

分页时返回的最多数目,范围在 1~100 之间。

50
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

返回信息。

success
Statusstring

API 执行状态,取值如下:

  • success:执行成功。
  • fail:执行失败。
success
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883
Databasesarray

查询到的数据库列表。

Databasesstring

数据库名称。

acc_001

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Databases": {
    "Databases": [
      "acc_001"
    ]
  }
}

错误码

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