ListCollections - 查询向量集列表

查询向量集列表。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

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

命名空间,默认为 public。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
NamespacePasswordstring

命名空间对应的密码。

testpassword
RegionIdstring

实例所在的地域 ID。

cn-hangzhou
WorkspaceIdstring

多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空,当和 DBInstanceId 同时指定时以此参数为准。

gp-ws-*****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

总条数。

1
Collectionsarray

向量集列表。

Collectionstring

向量集名称。

["document"]
DBInstanceIdstring

实例 ID。

gp-xxxxxxxxx
RegionIdstring

地域 ID。

cn-hangzhou
Namespacestring

命名空间。

mynamespace
Messagestring

返回信息。

Successful
Statusstring

API 执行状态,取值如下:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Count": 1,
  "Collections": {
    "Collection": [
      "[\"document\"]"
    ]
  },
  "DBInstanceId": "gp-xxxxxxxxx",
  "RegionId": "cn-hangzhou",
  "Namespace": "mynamespace",
  "Message": "Successful",
  "Status": "success"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-04OpenAPI 入参发生变更查看变更详情
2023-11-07API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情