调用ListVectorBuckets接口列举当前账号下的所有向量Bucket,还可以通过设置prefix、marker或者max-keys参数列举满足指定条件的向量Bucket。
权限说明
阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM Policy概述或Bucket Policy授予操作权限。
|
API |
Action |
说明 |
|
ListVectorBuckets |
|
列举向量Bucket。 |
请求语法
GET / HTTP/1.1
Host: cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
请求头
此接口仅包含公共请求头。更多信息,请参见公共HTTP头定义。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
|
prefix |
字符串 |
否 |
my |
向量Bucket名称的前缀匹配。只有向量Bucket名称匹配该前缀的向量Bucket才会被返回。 |
|
marker |
字符串 |
否 |
mybucket |
设定结果从marker之后按字母排序的第一个开始返回。 |
|
max-keys |
数值 |
否 |
100 |
指定返回向量Bucket的最大数目。取值范围:1~1000,默认值:100。 |
响应头
此接口仅涉及公共响应头。更多信息,请参见公共HTTP头定义。
响应元素
调用ListBuckets(GetService)接口时,如果所有Bucket已返回,则返回的JSON中不包含Prefix、Marker、MaxKeys、IsTruncated和NextMarker响应元素。
|
名称 |
类型 |
示例值 |
描述 |
|
ListAllMyBucketsResult |
容器 |
不涉及 |
保存ListVectorBuckets请求结果的容器。 |
|
Prefix |
字符串 |
my |
本次查询结果的前缀。 父节点:ListAllMyBucketsResult |
|
Marker |
字符串 |
mybucket |
本次ListVectorBuckets的起点。 父节点:ListAllMyBucketsResult |
|
MaxKeys |
数值 |
10 |
响应请求内返回结果的最大数目。 父节点:ListAllMyBucketsResult |
|
IsTruncated |
布尔值 |
true |
是否所有的结果都已经返回。 取值范围如下:
父节点:ListAllMyBucketsResult |
|
NextMarker |
字符串 |
mybucket10 |
用于继续查询时给marker赋值。表示下一次ListVectorBuckets以此为marker,将未返回的结果返回。 父节点:ListAllMyBucketsResult |
|
Buckets |
容器 |
不适用 |
保存多个向量Bucket信息的容器。 父节点:ListAllMyBucketsResult |
|
Name |
字符串 |
acs:ossvector:cn-shanghai:103735**********:test-bucket-3 |
向量 Bucket 的标识信息,返回 Bucket ARN。 父节点:Buckets |
|
CreationDate |
字符串 |
2014-02-07T18:12:43.000Z |
向量Bucket创建时间。 父节点:Buckets |
|
ExtranetEndpoint |
字符串 |
cn-shanghai.oss-vectors.aliyuncs.com |
向量Bucket的公网访问域名。 父节点:Buckets |
|
IntranetEndpoint |
字符串 |
cn-shanghai-internal.oss-vectors.aliyuncs.com |
向量Bucket的内网访问域名。 父节点:Buckets |
|
Location |
字符串 |
oss-cn-shanghai |
OSS专用Region ID。 父节点:Buckets |
|
Region |
字符串 |
cn-shanghai |
阿里云通用Region ID。 父节点:Buckets |
示例
请求示例
GET /?prefix=my&marker=mybucket&max-keys=10 HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: cn-hangzhou-internal.oss-vectors.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
返回示例
HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-type: application/json
Content-Length: 545
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
{
"ListAllMyBucketsResult": {
"Prefix": "my",
"Marker": "mybucket",
"MaxKeys": 10,
"IsTruncated": true,
"NextMarker": "mybucket10",
"Buckets": [
{
"CreationDate": "2014-02-07T18:12:43.000Z",
"ExtranetEndpoint": "cn-shanghai.oss-vectors.aliyuncs.com",
"IntranetEndpoint": "cn-shanghai-internal.oss-vectors.aliyuncs.com",
"Location": "oss-cn-shanghai",
"Name": "acs:ossvector:cn-shanghai:103735**********:test-bucket-3",
"Region": "cn-shanghai"
},
{
"CreationDate": "2014-02-05T11:21:04.000Z",
"ExtranetEndpoint": "cn-shanghai.oss-vectors.aliyuncs.com",
"IntranetEndpoint": "cn-shanghai-internal.oss-vectors.aliyuncs.com",
"Location": "oss-cn-hangzhou",
"Name": "acs:ossvector:cn-shanghai:103735**********:test-bucket-4",
"Region": "cn-hangzhou"
}
]
}
}
SDK
ListVectorBuckets接口所对应的各语言SDK如下:
命令行工具ossutil
ListVectorBuckets接口所对应的ossutil命令,请参见list-vector-buckets。
错误码
|
错误码 |
HTTP状态码 |
描述 |
|
AccessDenied |
403 |
请求中没有用户验证信息(即匿名访问)。 |