The create_vector_bucket interface is used to create vector buckets. This article explains how to create a vector bucket using the create_vector_bucket interface of the TOS Vectors Python SDK.

Notes

You need to fill in the region and access domain in the sample code according to your actual situation. For details, see Region and Access Domain (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 Configure Long-Term Access Credentials.

The TOS Vectors Python SDK supports using temporary access credentials. It also supports configuring timeout mechanisms, retry policies, and other options. You can flexibly set these according to your business needs to enhance application security. For details, see Common Configuration Scenarios.

Anonymous bucket creation requests are not allowed. Each user can create up to 100 vector buckets globally (including standard buckets).

Permissions required

The main account has all permissions by default, but IAM users have no permissions by default. If you need to use a sub-account to perform the create_vector_bucket operation, the main account must grant the following permissions to the sub-account through IAM policies and bucket policies:

tosvectors:CreateVectorBucket

Code example

Create vector bucket

# Create vector bucket​
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'​
​
try:​
    # Create a VectorClient object; all vector operations are handled through VectorClient.​
    client = tos.VectorClient(ak, sk, endpoint, region)​
    ​
    # Create a vector storage bucket. The bucket name must follow these rules:​
    # 1. Be between 3 and 32 characters long​
    # 2. Contain only lowercase letters, numbers, and hyphens (-)​
    # 3. Cannot start or end with a hyphen (-)​
    result = client.create_vector_bucket(vector_bucket_name)​
    ​
    # Print the creation success message​
    print('Vector bucket created successfully')​
    print('Request ID: {}'.format(result.request_id))​
    print('Status codes: {}'.format(result.status_code))​
    ​
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))​