You need to enable JavaScript to run this app.
Key Management System

Key Management System

Copy page
Download PDF
Key management
EnableKeyRotation - Enable user master key rotation
Copy page
Download PDF
EnableKeyRotation - Enable user master key rotation

Enable user master key rotation

Debug

Request parameters

The table below lists only the parameters unique to this interface and some common parameters. For more information, see Common Parameters.

Parameter
Type
Required
Example Value
Description
Action
String
yes

EnableKeyRotation

The action to perform, value: EnableKeyRotation.

Version
String
Yes

2021-02-18

api version, value: 2021-02-18.

KeyID
String
No

39a0e7c6-b7dd-4c83-b400-3449bb95403a

Primary key ID, choose one:
KeyringName and KeyName
KeyID

KeyringName
String
No

keyring-test

Keyring name, length 2 to 31 characters. Valid characters: [a-zA-Z0-9-_]

KeyName
String
No

key-test

Primary key name, 2-31 characters long. Valid characters: [a-zA-Z0-9-_]

return parameters

This interface has no unique return parameters. For more information, see response structure.

Request example

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


Response example

{ 
  "ResponseMetadata": { 
    "RequestId": "2024070816444717114705310060ECFB", 
    "Action": "EnableKeyRotation", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  } 
}

Error Code

The table below lists error codes related to this interface and business logic. For common error codes, see the Common Error Codes document.

Status Code
Error Code
Error message
Description
400
InvalidParameter

The request parameter %s is invalid.

400
InvalidKeyOrigin

Current key origin: %s does not allow to perform this action

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

403
KeyMaterialExpire

Key expire in, %s

404
Not Found

Not found %s [%s].

500
UndefinedError

Undefined Internal Error. Pls Contact With Admin.

Last updated: 2025.06.27 15:24:16