DescribeDatabases - 查询实例库列表

更新时间:
复制 MD 格式

调用 DescribeDatabases 接口,查询指定云数据库 MongoDB 版实例上真实存在的全部数据库名称列表。

接口说明

  • 只读接口,同步返回(非异步受理)。

  • 数据源为实例直连(listDatabases),不落库元数据;返回结果包含系统库 admin、local、config,原样返回不过滤。管控侧有短缓存,短时重复调用返回可能非实时。

  • 支持云盘版与本地盘版实例。

  • 建号表单中 DBName(账号所在库)若做成下拉选择,数据源即此接口;下拉项需过滤掉 local(后端禁止将账号建到 local 库),admin 可保留。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeDatabases

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无 无

请求参数

名称

类型

必填

描述

示例值

DBInstanceId

string

是

实例 ID。

dds-bp14bf67a76d****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

009D2572-6839-43C0-8D89-44DB46CBA2EA

Databases

object

Database

array

数据库列表。

string

数据库列表。

admin

示例

正常返回示例

JSON格式

{
  "RequestId": "009D2572-6839-43C0-8D89-44DB46CBA2EA",
  "Databases": {
    "Database": [
      "admin"
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

403 ResponseEmptyError The Response is empty, maybe server request timeout.

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

变更历史

更多信息,参考变更详情。