修改主密钥属性

最近更新时间:2019-04-11 10:25:10

1. 接口描述

本接口 (SetKeyAttributes) 用于修改 KeyId 的属性信息。

kms 请求域名接口和说明可参考 地域和域名说明

说明:

任何时候,包括内测期间,如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。

  • 输入参数有些是可选的,不填取默认值。
  • 输出参数在成功情况下所有出参都会返回给用户;失败情况下,至少会有code, message, requestId返回。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 是否必选 类型 描述
keyId String 调用 CreateKey 生成的 CMK 的全局唯一标识符
alias String 作为密钥更容易辨识,更容易被人看懂的别名,可为空,0 - 32个字符

3. 输出参数

参数名称 类型 描述
code Int 0:表示成功,其他返回值的含义可以参考 错误码
message String 错误提示信息
requestId String 服务器生成的请求 ID,出现服务器内部错误时,用户可提交此 ID 给后台定位问题

4. 示例

输入:

 https://kms-sh.api.tencentyun.com/v2/index.php?Action=SetKeyAttributes
 &keyId=kms-345sdfk
 &alias=kms-test-1
 &<公共请求参数>

输出:

{
"code" : 0,
"message" : "",
"requestId":"14534664555"
}