Help Center/ Object Storage Service/ Tools Guide/ obsutil/ Bucket Commands/ Obtaining the Encryption Configuration of a Bucket
Updated on 2026-09-20 GMT+08:00

Obtaining the Encryption Configuration of a Bucket

Function

You can use this command to obtain the encryption configuration of a bucket.

Constraints

To obtain the encryption configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetEncryptionConfiguration granted using IAM or GetEncryptionConfiguration granted using a bucket policy). For details, see Differences Between OBS Permissions Control Methods, Using IAM Roles or Policies to Grant Access to OBS, and Creating a Custom Bucket Policy.

Command Line Structure

  • Windows
    obsutil encryption obs://bucket -method=get [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
  • macOS or Linux
    ./obsutil encryption obs://bucket -method=get [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]

Examples

  • In Windows, run obsutil encryption obs://test-bucket -method=get -localfile=d:\temp\encryption-output.json to export the encryption configuration file of bucket test-bucket to the local file encryption-output.json.
    obsutil encryption obs://test-bucket -method=get -localfile=d:\temp\encryption-output.json
    
    Start at 2024-09-30 07:59:28.8675681 +0000 UTC
    
    Get encryption configuration succeed for bucket [test-bucket], requestId is [00000199766AD0AB4015BC408DBE55EC]

Parameter Description

Parameter

Optional or Mandatory

Description

bucket

Mandatory

The bucket name

method

Mandatory

The method. Set it to get when you obtain the encryption configuration of a bucket.

localfile

Mandatory

The local file to which the bucket's encryption configuration is exported. If this parameter is not specified, the configuration defaults to standard output.

config

Optional (additional parameter)

The user-defined configuration file for executing the current command. For details about parameters that can be configured, see Configuration Parameters.

e

Optional (additional parameter)

The endpoint

i

Optional (additional parameter)

The user's AK

k

Optional (additional parameter)

The user's SK

t

Optional (additional parameter)

The user's security token

Helpful Links