DisableKeyRotation - 禁用用户主密钥轮转--密钥管理系统-火山引擎

文档中心

立即注册

导航

DisableKeyRotation - 禁用用户主密钥轮转

最近更新时间：2025.06.04 16:50:32首次发布时间：2024.08.29 17:27:16

禁用用户主密钥轮转

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DisableKeyRotation	要执行的操作，取值：DisableKeyRotation。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyID	String	否	39a0e7c6-b7dd-4c83-b400-3449bb95403a	主密钥ID，二选一： KeyringName 和 KeyName KeyID
KeyringName	String	否	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	否	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]

返回参数

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

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407081649110162321720940BC0D6",
    "Action": "DisableKeyRotation",
    "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
400	InvalidOperation	The request was rejected because the specified resource is not valid for this operation.
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
403	KeyMaterialExpire	Key expire in, %s
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.