All Products
Search
Document Center

Object Storage Service:get-bucket-transfer-acceleration

Last Updated:Mar 20, 2026

Retrieves the transfer acceleration configuration of a bucket.

Usage notes

  • Only the bucket owner or RAM users granted the oss:PutBucketTransferAcceleration permission can run this command.

  • If transfer acceleration is not configured for the bucket, the command does not return any transfer acceleration configuration.

For more information, see Transfer acceleration in the Developer Guide.

Syntax

ossutil api get-bucket-transfer-acceleration --bucket <value> [--output-format <value>] [flags]

Parameters

ParameterTypeRequiredDescription
--bucketstringYesThe name of the bucket.
--output-formatstringNoThe output format. Valid values: json, yaml. If not specified, the output uses the default text format.
Note: For all supported global flags, see Command-line options.

Examples

Query the transfer acceleration configuration (default output)

ossutil api get-bucket-transfer-acceleration --bucket examplebucket

Query and format the output as JSON

ossutil api get-bucket-transfer-acceleration --bucket examplebucket --output-format json

Query and format the output as YAML

ossutil api get-bucket-transfer-acceleration --bucket examplebucket --output-format yaml

What's next