ListDocumentCollections - 查询文档库列表 - 云原生数据仓库AnalyticDB

查询文档库列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:ListDocumentCollections

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
Namespace	string	否	命名空间，默认为 public。说明您可以通过 CreateNamespace 接口创建命名空间，通过 ListNamespaces 接口查看列表。	mynamespace
NamespacePassword	string	是	命名空间对应的密码。说明本值为 CreateNamespace 接口指定。	testpassword
RegionId	string	是	实例所在地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	创建状态，取值说明： success：成功 fail：失败	success
Message	string	返回信息。	success
Count	integer	总条数。	10
Items	object
CollectionList	array<object>	文档库列表。
	object	文档库信息。
CollectionName	string	文档库名称。	document
EmbeddingModel	string	向量化算法。	text-embeddding-v1
Dimension	integer	向量维度。	1536
FullTextRetrievalFields	string	用于全文检索的字段，多个字段用英文逗号（,）分隔。	title
Metadata	string	元数据。	{'page': 'int', 'title': 'text'}
Parser	string	用于全文检索的分词器。	zh_cn
Metrics	string	向量相似度算法。	cosine
SupportSparse	boolean	是否支持稀疏向量。默认值：false。	true
SparseRetrievalFields	string	用于构建稀疏向量的 metadata 字段，多个字段用英文逗号（,）分隔。	title,abstract

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "success",
  "Count": 10,
  "Items": {
    "CollectionList": [
      {
        "CollectionName": "document",
        "EmbeddingModel": "text-embeddding-v1",
        "Dimension": 1536,
        "FullTextRetrievalFields": "title",
        "Metadata": "{'page': 'int', 'title': 'text'}",
        "Parser": "zh_cn",
        "Metrics": "cosine",
        "SupportSparse": true,
        "SparseRetrievalFields": "title,abstract"
      }
    ]
  }
}

错误码

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

变更历史

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