ListDocuments_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为3000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:ListDocuments
Create
Document
acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-xxxxxxxxx参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
Namespacestring

命名空间,默认为 public。展开详情

示例值:mynamespace参考取值来源:
    ListNamespaces
    CreateNamespace
Collectionstring

文档库名称。展开详情

示例值:document参考取值来源:
    ListCollections
    CreateCollection
    UpsertCollectionData
RegionIdstring

实例所在地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
NamespacePasswordstring

命名空间对应的密码。展开详情

示例值:testpassword
MaxResultsinteger<int32>

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

示例值:100
NextTokenstring

分页查询时,下一个查询开始 Token。

示例值:caeba0bbb2be03f84eb48b699f0a4883

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

接口返回详细信息。

示例值:Successful
Statusstring

API 执行状态,取值说明:展开详情

示例值:success
Itemsobject
NextTokenstring

分页查询时,下一个查询开始 Token。为空时表示此数据是最后一页的数据。

示例值:caeba0bbb2be03f84eb48b699f0a4883
Countinteger<int32>

总条数。

示例值:3

返回示例

变更历史

变更时间变更内容概要操作
2024-07-18
新增请求参数MaxResults
新增请求参数NextToken
变更返回参数

相关示例

查询文档列表
2023-11-30