All Products
Search
Document Center

Object Storage Service:GetVectorBucket

Last Updated:Sep 25, 2025

The GetVectorBucket operation retrieves the details of a vector bucket.

Permissions

By default, an Alibaba Cloud account has all permissions. However, Resource Access Management (RAM) users and RAM roles that belong to an Alibaba Cloud account have no permissions by default. The Alibaba Cloud account or an administrator must grant permissions for operations using a RAM policy or a bucket policy.

API

Action

Description

GetVectorBucket

oss:GetVectorBucket

Gets information about a vector bucket.

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

Description

BucketInfo

Container

N/A

A container for the information about the vector bucket.

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 of the vector bucket.

Parent node: BucketInfo

IntranetEndpoint

String

cn-hangzhou-internal.oss-vectors.aliyuncs.com

The internal endpoint of the vector bucket.

Parent node: BucketInfo

Location

String

oss-cn-hangzhou

The region where the vector bucket is located. The value is an Object Storage Service (OSS)-specific region ID.

Parent node: BucketInfo

Region

String

cn-hangzhou

The region where the vector bucket is located. The value is a general-purpose Alibaba Cloud region ID.

Parent node: BucketInfo

Name

String

acs:ossvector:cn-shanghai:103735**********:test-bucket-3

The identity of the vector bucket. The value is the Alibaba Cloud Resource Name (ARN) of the bucket.

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"
    }
}

Error codes

Error code

HTTP status code

Description

NoSuchBucket

404

The specified vector bucket does not exist.

AccessDenied

403

Permission to view the bucket information is denied. Only the bucket owner can view the bucket information.

InvalidVectorBucketName

400

The name of the vector bucket does not follow the naming conventions.