GetBucketEncryption--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

GetBucketEncryption

最近更新时间：2024.08.01 20:30:31首次发布时间：2023.10.12 19:40:16

功能描述

此接口用于获取指定存储桶的服务端加密配置。

注意事项

仅华北2（北京）地域支持 GetBucketEncryption 接口。
只能使用 HTTPS 协议调用 GetBucketEncryption 接口。
只有拥有 tos:GetBucketEncryption 权限的用户才能调用 GetBucketEncryption 接口。默认情况下，存储桶的所有者直接拥有 tos:GetBucketEncryption 权限，存储桶所有者也可以将该权限授予给其他用户。

请求消息样式

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

请求参数和消息头

该请求使用的公共请求消息头，请参见公共参数。

名称	位置	参数类型	是否必选	示例值	说明
encryption	Query	String	是	-	代表 GetBucketEncryption 请求的特殊标识。

请求元素

该请求不使用消息元素。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

名称	参数类型	示例值	说明
Rule	Array	-	桶加密规则信息。
ApplyServerSideEncryptionByDefault	Array	-	服务端加密的配置信息。
SSEAlgorithm	String	AES256	服务端加密的默认加密方式，取值说明如下： `kms`：使用 SSE-KMS 加密方式。 `AES256`：使用 SSE-TOS 加密方式。说明使用 SSE-KMS 进行服务端加密会产生 API 调用费用，创建 KMS 密钥会产生密钥托管费用，由 KMS 收取，更多信息，请参见 KMS 计费说明。
KMSMasterKeyID	String	trn:kms:cn-beijing:200000*****:keyrings/ring-test/keys/key-test	SSE-KMS 加密使用的主密钥。说明当 `SSEAlgorithm` 值为 `kms` 时，才会返回 `KMSMasterKeyID` 参数。

请求示例

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

响应示例

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"
        }
    }
}