ListVectorBuckets - Object Storage Service - Alibaba Cloud Documentation Center

The ListVectorBuckets operation lists all vector buckets in your account. You can also set the `prefix`, `marker`, or `max-keys` parameters to list vector buckets that meet specific conditions.

Permissions

An Alibaba Cloud account has all permissions by default. A Resource Access Management (RAM) user or RAM role has no permissions by default. The Alibaba Cloud account or an administrator must grant permissions through 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.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

Request headers

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

Request parameters

Name	Type	Required	Example	Description
prefix	String	No	my	The prefix that the names of vector buckets must contain. Only vector buckets whose names contain this prefix are returned.
marker	String	No	mybucket	The position from which the query starts. The results are returned in alphabetical order, starting from the entry that follows the marker.
max-keys	Value	No	100	The maximum number of vector buckets to return. Value range: 1 to 1000. Default value: 100.

Response headers

This operation returns only common response headers. For more information, see Common response headers.

Response elements

Note

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

Name	Type	Example	Description
ListAllMyBucketsResult	Container	N/A	The container for the results of the ListVectorBuckets request.
Prefix	String	my	The prefix of the query results. Parent node: ListAllMyBucketsResult
Marker	String	mybucket	The start position of the ListVectorBuckets query. Parent node: ListAllMyBucketsResult
MaxKeys	Value	10	The maximum number of results 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 for the next paged query. You can use this value for the `marker` parameter in the next ListVectorBuckets request to retrieve the next page of 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. The Bucket ARN is returned. 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"
        }
    ]
  }
}

Error codes

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