You need to enable JavaScript to run this app.
Torch Object Storage

Torch Object Storage

  • Documentation
    • Torch Object StorageAPI ReferenceBucketBasic Bucket OperationsGetBucketInfo
Copy page
Download PDF
Basic Bucket Operations
GetBucketInfo
Copy page
Download PDF
GetBucketInfo

Function description

This interface queries the configuration information of the bucket.

Request syntax 

GET /?bucketInfo HTTP/1.1 
Host: bucketname.tos-cn-beijing.volces.com 
Date: Fri, 30 Jul 2021 08:05:36 +0000 
Authorization: authorization string

Request parameters and headers

This request uses common request headers. See Common parameters.

NameTypeRequiredSample ValueDescription
bucketInfoQueryStringYes-

Request body elements

This request does not use request message elements.

Response headers

This request returns the common response message header. See Common parameters.

Response body elements

NameTypeSample ValueDescription
BucketObject-Bucket information.

Name

String

tos-example

Name of the bucket.
Parent node: Bucket

Owner

Object

-

Information about the account owning the bucket.
Parent node: Bucket

ID

String

20012****

The account ID that owns the bucket.
Parent node: Owner

DisplayName

String

user-name

Name of the account that owns the bucket.
Parent node: Owner

CreationDate

String

2025-01-17T04:25:18.000Z

The creation time of the bucket, in UTC format.
Parent node: Bucket

StorageClass

String

STANDARD

The default storage class of the bucket,For detailed information, please refer to Storage type.
Parent node: Bucket

Type

String

fns

Bucket type, with the following values:

  • fns: flat bucket.
  • hns: hierarchical bucket.

Parent node: Bucket

ProjectName

String

default

Project to which the bucket belongs.
Parent node: Bucket

Location

String

cn-beijing

The region where the bucket is located
Parent node: Bucket

AzRedundancy

String

single-az

The bucket's AZ redundancy type with the following values:

  • single-az: single AZ redundancy.
  • multi-az: multi-AZ redundancy.

Parent node: Bucket

ExtranetEndpoint

String

tos-cn-beijing.volces.com

The bucket's TOS protocol public network access domain name.
Parent node: Bucket

IntranetEndpoint

String

tos-cn-beijing.ivolces.com

Private network access domain of the bucket's TOS protocol.
Parent node: Bucket

ExtranetS3Endpoint

String

tos-s3-cn-beijing.volces.com

Public network access domain of the bucket's S3 protocol.
Parent node: Bucket

IntranetS3Endpoint

String

tos-s3-cn-beijing.ivolces.com

The S3 protocol private network access domain name for the bucket.
Parent node: Bucket

Versioning

String

Enabled

The versioning status of the bucket is described as follows:

  • Enabled: versioning is enabled.
  • Suspended: version control function paused.
  • Empty: version control function not enabled.

Parent node: Bucket

CrossRegionReplication

String

Enabled

The bucket's cross-region replication status, with the following possible values:

  • Enabled: cross-region replication enabled.
  • Disabled: cross-region replication not enabled.

Parent node: Bucket

TransferAcceleration

String

Enabled

The transfer acceleration status of the bucket is explained as follows:

  • Enabled: transfer acceleration is enabled.
  • Disabled: transfer acceleration is disabled.

Parent node: Bucket

AccessMonitor

String

Enabled

Storage bucket access tracking status with the following values explained:

  • Enabled: Access tracking is enabled.
  • Disabled: Access tracking is disabled.

Parent node: Bucket

ServerSideEncryptionConfiguration

Object

-

Server-side encryption configuration for the storage bucket.
Parent node: Bucket

Rule

Array

-

Server-side encryption rules.
Parent node: ServerSideEncryptionConfiguration

ApplyServerSideEncryptionByDefault

Array

-

Server-side encryption configuration information.
Parent node: Rule

SSEAlgorithm

String

AES256

Server-side encryption methods, with meanings as follows:

  • kms: uses SSE-KMS encryption method.
  • AES256: uses SSE-TOS encryption method.
  • Empty: server-side encryption is not enabled.

Parent node: ApplyServerSideEncryptionByDefault

KMSMasterKeyID

String

trn:kms:cn-beijing:200000*****:keyrings/ring-test/keys/key-test

The master key used when encrypting with SSE-KMS.

The KMSMasterKeyID parameter is returned only when the SSEAlgorithm value is kms.

Parent node: ApplyServerSideEncryptionByDefault

Sample request 

GET /?bucketInfo HTTP/1.1 
Host: bucketname.tos-cn-beijing.volces.com 
Date: Fri, 30 Jul 2021 08:05:36 +0000 
Authorization: authorization string

Sample response 

HTTP/1.1 200 OK 
Date: Wed, 09 Apr 2025 09:01:45 GMT 
Server: TosServer 
x-tos-id-2: 1e89f203jld00006-a444fd0 
x-tos-request-id: 1e89f203b2d00006-a444ed0 
Content-Length: 643 
{ 
    "Bucket": { 
        "Name": "test", 
        "Owner": { 
            "ID": "214748****", 
            "DisplayName": "214748****" 
        }, 
        "CreationDate": "2025-04-02T06:09:12.000Z", 
        "StorageClass": "STANDARD", 
        "ProjectName": "default", 
        "Type": "fns", 
        "Location": "cn-beijing", 
        "AzRedundancy": "single-az", 
        "ExtranetEndpoint": "tos-cn-beijing.volces.com", 
        "IntranetEndpoint": "tos-cn-beijing.ivolces.com", 
        "ExtranetS3Endpoint": "tos-s3-cn-beijing.volces.com", 
        "IntranetS3Endpoint": "tos-s3-cn-beijing.ivolces.com", 
        "Versioning": "", 
        "CrossRegionReplication": "Disabled", 
        "TransferAcceleration": "Disabled", 
        "AccessMonitor": "Disabled", 
        "ServerSideEncryptionConfiguration": { 
            "Rule": { 
                "ApplyServerSideEncryptionByDefault": { 
                    "SSEAlgorithm": "" 
                } 
            } 
        } 
    } 
}
Last updated: 2025.06.30 17:27:07