校验 Catalog 的 BYOK SSE-KMS 配置:用下发的临时凭证对存储桶做一次 SSE-KMS 写探针并校验。本接口仅校验指定客户主密钥能否用于 Catalog 的 BYOK SSE KMS，不会自动为 Catalog 下的所有表启用加密。客户主密钥通过 oss.sse.kms.key-id 配置在 Catalog 级别。创建表时，需要通过表属性 oss.sse.kms.enabled=true 为指定表启用 SSE KMS。
接口说明
本接口仅校验指定客户主密钥能否用于 Catalog 的 BYOK SSE KMS，不会自动为 Catalog 下的所有表启用加密。客户主密钥通过 oss.sse.kms.key-id 配置在 Catalog 级别。创建表时，需要通过表属性 oss.sse.kms.enabled=true 为指定表启用 SSE KMS。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dlf:VerifyCatalogKms |
none |
*全部资源
|
无 | 无 |
请求语法
POST /dlf/v1/catalogs/{catalog}/kms/verify HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| catalog |
string |
是 |
待校验 BYOK SSE-KMS 配置的 Catalog 名称。 |
my_catalog |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
校验请求体，包含待验证的 KMS 客户主密钥 ID。 |
{"kmsKeyId":"key- 1234567890abcdef"} |
| kmsKeyId |
string |
是 |
待验证的 KMS 客户主密钥（CMK）ID。服务端将使用该密钥执行 SSE-KMS 写探针。 |
key-1234567890abcdef |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| success |
boolean |
校验是否成功。true 表示写探针成功且对象的 true SSE-KMS 配置符合预期；false 表示校验失 败。 |
true |
| serverSideEncryption |
string |
探针对象实际使用的服务端加密方式。校验成 KMS 功时返回 KMS。 |
KMS |
| kmsKeyId |
string |
探针对象实际使用的 KMS 密钥标识。校验成功 key-1234567890abcdef 时与请求指定的客户主密钥相对应。 |
key-1234567890abcdef |
| errorCode |
string |
校验失败时返回的错误码；校验成功时为空字 KeyNotFound 符串。 |
KeyNotFound |
| hint |
string |
校验失败时返回的原因说明及处理建议；校验 The specified parameter KMS keyId is not found. 成功时为空字符串。 |
The specified parameter KMS keyId is not found. |
示例
正常返回示例
JSON格式
{
"success": true,
"serverSideEncryption": "KMS",
"kmsKeyId": " key-1234567890abcdef",
"errorCode": "KeyNotFound",
"hint": "The specified parameter KMS keyId is not found."
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。