金山云-文档中心-List Vector Buckets

对象存储(KS3)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

API文档

向量存储桶（KS3 Vectors）

向量存储桶相关

List Vector Buckets

最近更新时间：2026-11-03 19:52:57



描述

列举请求者名下全地域的所有向量 Bucket，可通过 prefix、nextToken、maxResults 参数筛选和分页。使用此接口，您必须是这个 Bucket 的拥有者或具有 ks3:ListVectorBuckets 权限。

ListVectorBuckets 为服务级别接口，可请求任意地域，获取结果为所有地域的存储向量桶排序结果。

请求

请求语法

POST /ListVectorBuckets HTTP/1.1
Host: ks3vectors-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Mon, 10 Dec 2025 12:49:14 GMT
Content-Type: application/json

{
  "maxResults": 5,
  "nextToken": "dGVzdC12ZWN0b3ItYmt0MQ==",
  "prefix": "example"
}

请求头

该接口仅使用公共请求头。

请求体

参数	是否必填	类型	说明
maxResults	否	integer	单次返回的向量桶最大数量，取值范围 1~500，默认 100。
nextToken	否	string	分页令牌，用于获取下一页结果。长度不超过 512，需原样传入上一次响应返回的 `nextToken`。
prefix	否	string	仅返回名称以指定前缀开头的向量桶。长度不超过 63。

响应

响应头

该接口仅返回公共响应头。

响应体

如果操作成功，服务将返回一个 HTTP 200 响应以及如下响应元素。如果操作失败，返回响应码中定义的错误码。

名称	父节点	数据类型	描述
nextToken	无	string	当有更多存储桶需要通过分页列出时包含此项，用于获取下一页结果的令牌。返回条数小于 `maxResults` 或列表为空表示已列举完毕。长度限制：最小 1，最大 512
vectorBuckets	无	容器	请求者拥有的向量存储桶列表
creationTime	vectorBuckets	long	创建时间（Unix 毫秒时间戳）
vectorBucketKrn	vectorBuckets	string	向量桶资源标识。使用 AWS4 签名协议时，该字段名改为 `vectorBucketArn`
vectorBucketName	vectorBuckets	string	向量存储桶的名称
location	vectorBuckets	string	向量 Bucket 所在的地域，格式为 KS3 专用 Region ID

示例

请求示例

POST /ListVectorBuckets HTTP/1.1
Host: ks3vectors-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Mon, 10 Dec 2025 12:49:14 GMT
Content-Type: application/json

{
  "maxResults": 5,
  "prefix": "example"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json
x-kss-request-id: 797014003c90a9b694003c9-b15a995-1vV80n-CVB-cb-ks31az-front-azd-vectors-2
Date: Mon, 10 Dec 2025 12:49:14 GMT
Server: ks3

{
  "nextToken": "dGVzdC12ZWN0b3ItYmt0MQ==",
  "vectorBuckets": [
    {
      "creationTime": 1755127842368,
      "vectorBucketName": "example-bucket",
      "vectorBucketKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket",
      "location": "beijing"
    },
    {
      "creationTime": 1755127842370,
      "vectorBucketName": "example-bucket-2",
      "vectorBucketKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket-2",
      "location": "beijing"
    }
  ]
}

错误码

HTTP 状态码	错误码	描述	典型触发场景
400	ValidationException	请求不合法	请求体 JSON 格式错误；`maxResults` 不在 1~500；`nextToken` 不是合法 Base64 或长度超过 512；`prefix` 长度超过 63
403	AccessDeniedException	访问被拒绝	签名校验失败；无 `ks3:ListVectorBuckets` 权限
500	InternalServerException	服务内部错误	服务内部异常

具体错误码通过响应头 x-kss-error-code 返回。

错误响应体格式示例：

{"message": "The vectorBucketName is invalid.", "fieldList": [{"path": "/vectorBucketName", "message": "..."}]}

fieldList 仅校验类错误携带；非校验类错误只返回 message。

文档导读

上一篇：Get Vector Bucket

下一篇：索引相关

纯净模式常规模式

纯净模式

点击可全屏预览文档内容