All Products
Search
Document Center

Object Storage Service:Get vector bucket information (Python SDK V2)

Last Updated:Jun 23, 2026

Call the GetVectorBucket operation through Python SDK V2 to retrieve information about a vector bucket.

Permissions

An Alibaba Cloud account has all permissions by default. RAM users and RAM roles have no permissions by default. An account owner or administrator must grant the required permissions by using a RAM policy overview or a bucket policy.

API

Action

Description

GetVectorBucket

oss:GetVectorBucket

Gets information about a vector bucket.

Method definition

get_vector_bucket(request: GetVectorBucketRequest, **kwargs) → GetVectorBucketResult

Request parameters

Parameter

Type

Description

request

GetVectorBucketRequest

Request parameters such as the vector bucket name. For more information, see GetVectorBucketRequest.

Return values

Type

Description

GetVectorBucketResult

The return value. For more information, see GetVectorBucketResult.

For the complete method definition, see get_vector_bucket.

Sample code

import argparse
import alibabacloud_oss_v2 as oss
import alibabacloud_oss_v2.vectors as oss_vectors

parser = argparse.ArgumentParser(description="vector get bucket sample")
parser.add_argument('--region', help='The region where the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The endpoint for accessing OSS.')
parser.add_argument('--account_id', help='The account ID.', required=True)

def main():
    args = parser.parse_args()

    # Load credentials from environment variables
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # Use the SDK's default configuration
    cfg = oss.config.load_default()
    cfg.credentials_provider = credentials_provider
    cfg.region = args.region
    cfg.account_id = args.account_id
    cfg.use_internal_endpoint = True  # To access OSS over the public network, set this parameter to False or remove this line.
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    vector_client = oss_vectors.Client(cfg)

    result = vector_client.get_vector_bucket(oss_vectors.models.GetVectorBucketRequest(
        bucket=args.bucket,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' bucket: {result.bucket_info},'
          )



if __name__ == "__main__":
    main()

References

For the complete sample code, see get_vector_bucket.py.