GET Bucket Encryption¶

OBS uses the GET method to obtain the encryption configuration of a specified bucket.

To perform this operation, you must have the s3:GetEncryptionConfiguration permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.

Request Syntax¶

GET /?encryption  HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.region.example.com
Accept: */*
Date: date
Authorization: authorization string

Request Parameters¶

This request contains no parameter.

Request Headers¶

This request uses common headers. For details about common request headers, see the section Common Request Headers.

Request Elements¶

This request involves no elements.

Response Syntax¶

HTTP/1.1 status_code
x-amz-request-id: request id
x-amz-id-2: id
Content-Type: application/xml
Content-Length: length
Date: date

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServerSideEncryptionConfiguration xmlns="http://obs.region.example.com/doc/2015-06-30/">
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>aws:kms</SSEAlgorithm>
            <KMSMasterKeyID>kmskeyid-value</KMSMasterKeyID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

Response Headers¶

This response uses common headers. For details about common response headers, see the section Common Response Headers.

Response Elements¶

This response contains the following elements to detail bucket encryption configuration:

**Table 1** Configuration elements of bucket encryption¶
Header	Description
ServerSideEncryptionConfiguration	Root element of the default encryption configuration of a bucket. Type: element Ancestor: none Children: Rule
Rule	Sub-element of the default encryption configuration of a bucket. Type: element Ancestor: ServerSideEncryptionConfiguration Children: ApplyServerSideEncryptionByDefault
ApplyServerSideEncryptionByDefault	Sub-element of the default encryption configuration of a bucket. Type: element Ancestor: Rule Children: SSEAlgorithm, KMSMasterKeyID
SSEAlgorithm	The server-side encryption algorithm used for encryption configuration of a bucket. Type: string Valid values: aws:kms Ancestor: ApplyServerSideEncryptionByDefault
KMSMasterKeyID	ID of the customer master key (CMK) used for SSE-KMS. Type: string Ancestor: ApplyServerSideEncryptionByDefault

Error Responses¶

In addition common error codes, this API also returns other error codes. The following table lists common errors and possible causes. For details, see Table 2.

**Table 2** Error codes related to getting bucket encryption configuration¶
Error Code	Description	HTTP Status Code
NoSuchEncryptionConfiguration	The specified bucket does not have any encryption configurations	404 Not Found

Sample Request¶

GET /?encryption HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date:  Thu, 21 Feb 2019 03:05:34 GMT
Authorization: authorization

Sample Response¶

HTTP/1.1 200 OK
Server: OBS
x-amz-request-id: BF26000001643670AC06E7B9A7767921
x-amz-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm
Date: Thu, 21 Feb 2019 03:05:34 GMT
Content-Length: 788

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServerSideEncryptionConfiguration xmlns="http://obs.region.example.com/doc/2015-06-30/">
    <Rule>
        <ApplyServerSideEncryptionByDefault>
            <SSEAlgorithm>aws:kms</SSEAlgorithm>
            <KMSMasterKeyID>4f1cd4de-ab64-4807-920a-47fc42e7f0d0</KMSMasterKeyID>
        </ApplyServerSideEncryptionByDefault>
    </Rule>
</ServerSideEncryptionConfiguration>

last updated: 2024-12-11 10:27 UTC - commit: 1084b97f9d241d7af788bdfaa536dba9679533f7