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

Torch Object Storage

Copy page
Download PDF
Server-side encryption
GetBucketEncryption
Copy page
Download PDF
GetBucketEncryption
Feature description​
This interface retrieves the server-side encryption configuration for a specified bucket.​
Notes​
  • The GetBucketEncryption interface can only be called using the HTTPS protocol.​
  • Only users with the tos:GetBucketEncryption permission can call the GetBucketEncryption interface. By default, the bucket owner has the tos:GetBucketEncryption permission directly, and the bucket owner can grant this permission to other users.​
  • HNS buckets do not currently support the GetBucketEncryption interface.​
Request syntax​
​
GET /?encryption HTTPS​
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 public request headers; see public parameters.​
​
Name​
Location​
Type​
Required​
Sample value​
Note​
encryption​
Query​
String​
Yes​
-​
Special identifier representing the GetBucketEncryption request.​
​
Request body elements;​
No elements are used.​
Response headers​
This request returns public response headers; see public parameters.​
Response body elements​
​
Name​
Type​
Sample value​
Note​
Rule​
Array​
-​
Bucket encryption rule information.​
ApplyServerSideEncryptionByDefault​
Array​
-​
Server-side encryption configuration information.​
SSEAlgorithm​
String​
AES256​
The default server-side encryption method and its values are as follows:​
  • kms: uses SSE-KMS encryption.​
  • AES256: uses SSE-TOS encryption and the AES256 algorithm.​
  • SM4: uses SSE-TOS encryption and the SM4 algorithm.​
tip​
Using SSE-KMS for server-side encryption generates API call fees, and creating KMS keys generates key management fees. These fees are charged by KMS. For more information, see KMS Billing Overview.​
KMSDataEncryption​
String​
AES256​
Encryption algorithm used with SSE-KMS encryption method, with the following values:​
  • AES256: AES256 encryption algorithm.​
  • SM4: SM4 encryption algorithm.​
KMSMasterKeyID​
String​
trn:kms:cn-beijing:200000*****:keyrings/ring-test/keys/key-test​
The master key used for SSE-KMS encryption.​
tip​
The KMSMasterKeyID parameter is returned only when the SSEAlgorithm value is kms.​
​
Sample request​
​
GET /?encryption HTTPS​
Host: bucketname.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Authorization: authorization string​
​
Sample response​
​
HTTPS 200 OK​
Date: Fri, 30 Jul 2021 13:53:55 GMT​
Server: TosServer​
x-tos-id-2: 1e89f203jld00006-a444fd0​
x-tos-request-id: 1e89f203b2d00006-a444ed0​
Content-Length: 143​
​
{​
"Rule":{​
"ApplyServerSideEncryptionByDefault":{​
"SSEAlgorithm":"kms",​
"KMSMasterKeyID":"trn:kms:cn-beijing:200000****:keyrings/ring-test/keys/key-test"​
}​
}​
}​
​
​
Last updated: 2025.09.08 17:32:48