Call ListVectorBuckets to list vector buckets - Object Storage Service

Call ListVectorBuckets to list all vector buckets in your Alibaba Cloud account. You can also filter the results by specifying the prefix, marker, or max-keys parameter.

Permissions

By default, an Alibaba Cloud account has full permissions. RAM users and RAM roles have no permissions by default. To grant permissions, the Alibaba Cloud account or account administrator must attach a RAM Policy or a Bucket Policy to the RAM user or role.

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

Request syntax

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

Request headers

This operation uses only Common request headers.

Request parameters

Name	Type	Required	Example	Description
prefix	String	No	my	The prefix that vector bucket names must contain. Only vector buckets whose names start with this prefix are returned.
marker	String	No	mybucket	Start listing results from the first entry that follows the marker, in alphabetical order.
max-keys	Value	No	100	The maximum number of vector buckets to return. Valid values: 1 to 1000. Default value: 100.

Response headers

This operation returns only Common response headers.

Response elements

Note

When you call ListBuckets (GetService), the response JSON does not include the Prefix, Marker, MaxKeys, IsTruncated, or NextMarker elements if all buckets have been returned.

Name	Type	Example	Description
ListAllMyBucketsResult	Container	N/A	The container for the ListVectorBuckets response.
Prefix	String	my	The prefix used in this query. Parent node: ListAllMyBucketsResult
Marker	String	mybucket	The starting position of this ListVectorBuckets request. Parent node: ListAllMyBucketsResult
MaxKeys	Value	10	The maximum number of entries returned in the response. Parent node: ListAllMyBucketsResult
IsTruncated	Boolean	true	Indicates whether all results are returned. Valid values: true: Not all results are returned. false: All results are returned. Parent node: ListAllMyBucketsResult
NextMarker	String	mybucket10	The marker to use in the next request. Set the marker parameter to this value in the next ListVectorBuckets request to retrieve the remaining results. Parent node: ListAllMyBucketsResult
Buckets	Container	N/A	The container for information about multiple vector buckets. Parent node: ListAllMyBucketsResult
Name	String	acs:ossvector:cn-shanghai:103735**********:test-bucket-3	The identifier of the vector bucket. Returns the 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 dedicated region ID for OSS. Parent node: Buckets
Region	String	cn-shanghai	The general-purpose region ID of Alibaba Cloud. 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.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

Use one of the following SDKs to call ListVectorBuckets:

ossutil command

To call ListVectorBuckets using ossutil, see list-vector-buckets.

Error code

Error code	HTTP status code	Description
AccessDenied	403	The request is anonymous and does not contain user authentication information.