1. 接口描述
本接口(DisableKey)用于禁用一个主密钥,处于禁用状态的 Key 无法用于加密、解密操作。直到 Key 恢复到启用状态之前,原来使用该 Key 加密的密文也无法解密。
kms请求域名接口和说明可参考 地域和域名说明。
说明:任何时候,包括内测期间,如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。
- 输入参数有些是可选的,不填取默认值。
- 输出参数在成功情况下所有出参都会返回给用户;失败情况下,至少会有 code,message,requestId 返回。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
keyId | 是 | String | 调用CreateKey生成的CMK全局唯一标识符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | - |
message | String | 错误提示信息。 |
requestId | String | 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。 |
4. 示例
输入
https://kms-gz.api.tencentyun.com/v2/index.php?Action=DisableKey &keyId=kms-345sdfk &<公共请求参数>
输出
{
"code" : 0,
"message" : "",
"requestId":"14534664555"
}