UpdateKey - 修改用户主密钥--密钥管理系统-火山引擎

文档中心

立即注册

导航

UpdateKey - 修改用户主密钥

最近更新时间：2024.08.29 17:20:28首次发布时间：2024.08.29 17:20:28

修改用户主密钥

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateKey	要执行的操作，取值：UpdateKey。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	是	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	是	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
NewKeyName	String	否	key-test1	新密钥名称，长度为 2 - 31 个字符
Description	String	否	test	新密钥描述，长度为 0 - 8192 个字符

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=UpdateKey&Version=2021-02-18&KeyringName=demo&KeyName=demo&NewKeyName=demo1&Description=demo1 HTTP/1.1
Host: kms.volcengineapi.com
X-Date: 20240708T015757Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407081000480760172051416B2F15",
    "Action": "UpdateKey",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	InvalidParameter	The request parameter %s is invalid.
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
403	AccessDenied	User is not authorized to do this action
404	Not Found	Not found %s [%s].
409	Conflict	The %s resource %s is conflict.
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.