Call GetVectorBucket to retrieve vector bucket details - Object Storage Service

Call the GetVectorBucket operation to retrieve details about a vector bucket.

Permissions

An Alibaba Cloud account has full permissions by default. RAM users and RAM roles have no permissions by default. An Alibaba Cloud account or an administrator must grant permissions using a RAM policy or a bucket policy.

API	Action	Description
GetVectorBucket	`oss:GetVectorBucket`	Get vector bucket information.

Request syntax

GET /?bucketInfo HTTP/1.1
Host: examplebucket-123***456.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 HTTP headers.

Response headers

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

Response elements

Name	Type	Example value	Description
BucketInfo	Container	N/A	A container that holds vector bucket information.
CreationDate	String	2013-07-31T10:56:21.000Z	The time when the vector bucket was created, in GMT format. Parent node: BucketInfo
ExtranetEndpoint	String	cn-hangzhou.oss-vectors.aliyuncs.com	The public endpoint for accessing the vector bucket. Parent node: BucketInfo
IntranetEndpoint	String	cn-hangzhou-internal.oss-vectors.aliyuncs.com	The internal endpoint for accessing the vector bucket. Parent node: BucketInfo
Location	String	oss-cn-hangzhou	The region where the vector bucket resides, in the OSS-specific region ID format. Parent node: BucketInfo
Region	String	cn-hangzhou	The region where the vector bucket resides, in the Alibaba Cloud general region ID format. Parent node: BucketInfo
Name	String	acs:ossvector:cn-shanghai:103735**********:test-bucket-3	The identity of the vector bucket, returned as the bucket ARN. Parent node: BucketInfo

Examples

Sample request

GET /?bucketInfo HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com  
Date: Thu, 17 Apr 2025 07:51:28 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

Sample response

HTTP/1.1 200
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2025 07:51:28 GMT
Connection: keep-alive
Content-Length: 531  
Server: AliyunOSS
{
  "BucketInfo": {
      "CreationDate": "2013-07-31T10:56:21.000Z",
      "ExtranetEndpoint": "cn-hangzhou.oss-vectors.aliyuncs.com",
      "IntranetEndpoint": "cn-hangzhou-internal.oss-vectors.aliyuncs.com",
      "Location": "oss-cn-hangzhou",
      "Name": "acs:ossvector:cn-shanghai:103735**********:examplebucket",
      "Region": "cn-hangzhou"
    }
}

SDK

The following SDKs support the GetVectorBucket operation:

ossutil command-line tool

For information about the ossutil command for the GetVectorBucket operation, see get-vector-bucket.

Error codes

Error code	HTTP status code	Description
NoSuchBucket	404	The specified vector bucket does not exist.
AccessDenied	403	You are not authorized to view this bucket's information. Only the bucket owner can view bucket information.
InvalidVectorBucketName	400	The vector bucket name does not meet naming requirements.