The get_vector_bucket_policy API queries the access policy of a specified vector bucket. This article explains how to use the get_vector_bucket_policy API through the TOS Vectors Python SDK to obtain this policy.

Notes

You need to fill in the region and access domain in the sample code according to your actual situation. For details, refer to Regions and Access Domains (Endpoint).

To prevent key leakage, the example code reads the Access Key ID and Secret Access Key from environment variables. Therefore, before using the SDK, you must configure long-term access credentials. For details, see Configuring Long-Term Access Credentials.

The TOS Vectors Python SDK supports temporary access credentials and also allows configuring timeout mechanisms, retry policies, and other settings. You can flexibly adjust these based on business needs to enhance application security. For details, see Common Configuration Scenarios.

Permissions required

The main account has all permissions by default, but IAM users have no permissions by default. If a sub-account needs to perform get_vector_bucket_policy operations, the main account must grant the following permissions to the sub-account through IAM policies and bucket policies:

tosvectors:GetVectorBucketPolicy

Code example

Get vector bucket policy

# Get vector storage bucket policy.​
import os​
import tos​
​
# Retrieve AK and SK information from environment variables.​
ak = os.getenv('TOS_ACCESS_KEY')​
sk = os.getenv('TOS_SECRET_KEY')​
# Fill in your endpoint and your region with the endpoint corresponding to the bucket's region. # For example, for China (Beijing), set your endpoint to https://tosvectors-cn-beijing.volces.com and your region to cn-beijing.​
endpoint = 'Provide your endpoint'​
region = 'Provide your region'​
vector_bucket_name = 'Provide your bucket name'​
account_id = os.getenv('TOS_ACCOUNT_ID')​
​
try:​
    # Create a VectorClient object; all vector operations are handled through VectorClient.​
    client = tos.VectorClient(ak, sk, endpoint, region)​
    ​
    # Get vector storage bucket policy.​
    result = client.get_vector_bucket_policy(​
        vector_bucket_name=vector_bucket_name,​
        account_id=account_id  ​
    )​
    ​
    # Print a message indicating that the policy was successfully retrieved.​
    print('Retrieve vector bucket policy successfully.')​
    print('Request ID: {}'.format(result.request_id))​
    print('Status code: {}'.format(result.status_code))​
    print('Policy content: {}'.format(result.policy))​
    ​
except tos.exceptions.TosClientError as e:​
    # The operation failed and a client exception was caught. This is usually due to invalid request parameters or a network exception.​
    print('fail with client error, message:{}, cause: {}'.format(e.message, e.cause))​
except tos.exceptions.TosServerError as e:​
    # The operation failed and a server exception occurred. See the response for the error details.​
    print('fail with server error, code: {}'.format(e.code))​
    # Use the request ID for troubleshooting purposes. We strongly recommend including the request ID in the logs.​
    print('error with request id: {}'.format(e.request_id))​
    print('error with message: {}'.format(e.message))​
    print('error with http code: {}'.format(e.status_code))​
    print('error with ec: {}'.format(e.ec))​
    print('error with request url: {}'.format(e.request_url))​
except Exception as e:​
    print('fail with unknown error: {}'.format(e))​