调试

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，UUID 形式。可通过 CreateKey 创建密钥时返回，或通过 DescribeKeys、DescribeKey 查询获取。KeyID 与 KeyringName + KeyName 二选一；传入 KeyID 时无需传入 KeyringName 和 KeyName；未传入 KeyID 时，必须同时传入 KeyringName 和 KeyName。
KeyringName	String	否	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]。可通过 CreateKeyring 创建密钥环时指定，或通过 DescribeKeyrings、QueryKeyring 查询获取。当不指定 KeyID 时，必须与 KeyName 同时传入；与 KeyID 二选一。
KeyName	String	否	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]。可通过 CreateKey 创建密钥时指定，或通过 DescribeKeys、DescribeKey 查询获取。当不指定 KeyID 时，必须与 KeyringName 同时传入；与 KeyID 二选一。

返回参数

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

请求示例

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	当前账号或子账号缺少执行该操作所需权限，请检查 IAM 授权策略。
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].	指定资源不存在或当前账号无权访问，请检查资源 ID、名称和地域是否正确。
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.	服务内部错误，请稍后重试；如持续出现，请联系技术支持。

最近更新时间：2026.09.03 18:00:31

这个页面对您有帮助吗？

有用

无用

密钥管理系统

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码