Call ListVectorBuckets to list vector buckets - Object Storage Service - Alibaba Cloud - Object Storage Service

Permissions

By default, an Alibaba Cloud account has full permissions on its resources. RAM users and RAM roles have no permissions by default. To allow a RAM user or RAM role to call this operation, an Alibaba Cloud account or a RAM administrator must grant the required permissions to the RAM user or RAM role using a RAM policy or a bucket policy.

API	Action	Description
ListVectorBuckets	`oss:ListVectorBuckets`	Lists vector buckets.

Request syntax

GET / HTTP/1.1
Host: cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request headers

This operation uses only common request headers. For more information, see Common HTTP Headers.

Request parameters

Parameter	Type	Required	Example	Description
prefix	String	No	my	The prefix that returned vector bucket names must start with.
marker	String	No	mybucket	The starting position for the result set. Results are returned in alphabetical order, beginning from the entry immediately after the specified marker.
max-keys	Number	No	100	The maximum number of vector buckets to return. Valid values: 1 to 1000. Default value: 100.

Response headers

This operation uses only common response headers. For more information, see Common HTTP Headers.

Response elements

Note

When you call the ListVectorBuckets operation, if all buckets are returned, the response does not include the Prefix, Marker, MaxKeys, IsTruncated, and NextMarker response elements.

Parameter	Type	Example	Description
ListAllMyBucketsResult	Container	N/A	The container for the ListVectorBuckets response.
Prefix	String	my	The prefix specified in the request. Parent node: ListAllMyBucketsResult
Marker	String	mybucket	The starting position for the ListVectorBuckets query. Parent node: ListAllMyBucketsResult
MaxKeys	Number	10	The maximum number of vector buckets to return in the response. Parent node: ListAllMyBucketsResult
IsTruncated	Boolean	true	Indicates whether all vector buckets are returned. Valid values: true: Not all vector buckets are returned. false: All vector buckets are returned. Parent node: ListAllMyBucketsResult
NextMarker	String	mybucket10	If IsTruncated is true, this element indicates the marker for the next page. Use this value as the `marker` parameter in a subsequent ListVectorBuckets request to retrieve the next page. Parent node: ListAllMyBucketsResult
Buckets	Container	N/A	The container for vector bucket details. Parent node: ListAllMyBucketsResult
Name	String	acs:ossvector:cn-shanghai:103735**********:test-bucket-3	The identifier of the vector bucket, returned as a bucket ARN. Parent node: Buckets
CreationDate	String	2014-02-07T18:12:43.000Z	The time when the vector bucket was created. Parent node: Buckets
ExtranetEndpoint	String	cn-shanghai.oss-vectors.aliyuncs.com	The public endpoint of the vector bucket. Parent node: Buckets
IntranetEndpoint	String	cn-shanghai-internal.oss-vectors.aliyuncs.com	The internal endpoint of the vector bucket. Parent node: Buckets
Location	String	oss-cn-shanghai	The OSS-specific region ID. Parent node: Buckets
Region	String	cn-shanghai	The general-purpose Alibaba Cloud region ID. Parent node: Buckets

Examples

Sample request

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

Sample response

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

You can call the ListVectorBuckets operation by using the following SDKs:

ossutil command-line tool

For information about the ossutil command that corresponds to the ListVectorBuckets operation, see list-vector-buckets.

Error codes

Error code	HTTP status code	Description
AccessDenied	403	The request is rejected because it lacks authentication information.