查询文档库中的文档列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:ListDocuments | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-xxxxxxxxx |
| Namespace | string | 否 | 命名空间，默认为 public。 说明
您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。
| mynamespace |
| Collection | string | 是 | 文档库名称。 说明
由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
| document |
| RegionId | string | 是 | 实例所在地域 ID。 | cn-hangzhou |
| NamespacePassword | string | 是 | 命名空间对应的密码。 说明
本值为 CreateNamespace 接口指定。
| testpassword |
| MaxResults | integer | 否 | 分页时返回的最多文档数，范围在 1～100 之间。 | 100 |
| NextToken | string | 否 | 分页查询时，下一个查询开始 Token。 | caeba0bbb2be03f84eb48b699f0a4883 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "Successful",
"Status": "success",
"Items": {
"DocumentList": [
{
"FileName": "music.txt",
"Source": "OSS"
}
]
},
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"Count": 3
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-18 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |