金山云-文档中心-Get Vector Bucket

对象存储(KS3)

查看更多结果

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

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

对象存储(KS3)

API文档

向量存储桶（KS3 Vectors）

向量存储桶相关

Get Vector Bucket

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



描述

获取向量存储桶的详细信息。使用此接口，您必须是这个 Bucket 的拥有者或具有 ks3:GetVectorBucket 权限。

请求

请求语法

POST /GetVectorBucket 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

{
  "vectorBucketName": "example-bucket"
}

也可以使用 vectorBucketKrn 指定目标桶，此时请求体为：

{
  "vectorBucketKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket"
}

可通过向量桶名称或向量桶 KRN 指定目标向量桶，vectorBucketName 与 vectorBucketKrn 严格二选一。同时提供返回 400 VectorBucketNameAndArnConflict，都不提供返回 400 VectorBucketInfoMissing

请求头

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

请求体

名称	数据类型	是否必选	示例值	描述
vectorBucketName	string	否（与 `vectorBucketKrn` 二选一）	test-vector-bucket	要查询的向量桶的名称
vectorBucketKrn	string	否（与 `vectorBucketName` 二选一）	krn:ksc:ks3vectors:cn-beijing:210676****:bucket/test-vector-bucket	要查询的向量桶的资源标识，格式为 `krn:ksc:ks3vectors:<region>:<accountId>:bucket/<bucketName>`

响应

响应头

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

响应体

{
  "vectorBucket": {
    "creationTime": 1755127842368,
    "location": "beijing",
    "vectorBucketName": "example-bucket",
    "vectorBucketKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket"
  }
}

名称	父节点	数据类型	示例值	描述
vectorBucket	无	容器	不适用	保存向量存储桶信息的容器
creationTime	vectorBucket	long	1755127842368	创建时间（Unix 毫秒时间戳）
vectorBucketKrn	vectorBucket	string	krn:ksc:ks3vectors:cn-beijing:210676****:bucket/test-vector-bucket	向量桶所在地域，取值与 KRN 中的 region 一致（如 `cn-beijing`）
vectorBucketName	vectorBucket	string	test-vector-bucket	向量存储桶的名称
location	vectorBucket	string	beijing	向量桶所在地域，取值与 KRN 中的 region 一致

使用 AWS4 签名协议时，响应字段 vectorBucketKrn 会改名为 vectorBucketArn

示例

请求示例

POST /GetVectorBucket 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

{
  "vectorBucketName": "example-bucket"
}

响应示例

HTTP/1.1 200
Content-Type: application/json
x-kss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2025 07:51:28 GMT
Connection: keep-alive
Server: ks3

{
  "vectorBucket": {
    "creationTime": 1755127842368,
    "location": "beijing",
    "vectorBucketName": "example-bucket",
    "vectorBucketKrn": "krn:ksc:ks3vectors:cn-beijing:103735000000:bucket/example-bucket"
  }
}

错误码

HTTP 状态码	错误码	描述	典型触发场景
400	ValidationException	请求不合法	请求体为空或 JSON 格式错误；`vectorBucketName` 与 `vectorBucketKrn` 同时提供（`VectorBucketNameAndArnConflict`）或都未提供（`VectorBucketInfoMissing`）；桶名/KRN 格式非法或 KRN 中的 region 与服务端配置不一致
403	AccessDeniedException	访问被拒绝	签名校验失败；无 `ks3:GetVectorBucket` 权限
404	NotFoundException	资源不存在	指定的向量桶不存在（`NoSuchBucket`）
500	InternalServerException	服务内部错误	服务内部异常

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

错误响应体格式示例：

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

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

文档导读

上一篇：Delete Vector Bucket

下一篇：List Vector Buckets

纯净模式常规模式

纯净模式

点击可全屏预览文档内容