调用RotateSecret接口手动轮转凭据_密钥管理服务(KMS)-阿里云帮助中心

使用限制：

• 同一阿里云账号每小时最多轮转50次。

• RotateSecret接口不支持轮转通用凭据。

说明仅支持自动轮转的凭据类型使用本接口。如需对通用凭据进行轮转，请使用PutSecretValue接口。

本文将提供一个示例，将名称为RdsSecret/Mysql5.4/MyCred的凭据进行手动轮转，轮转后新的凭据版本为000000123。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	RotateSecret	要执行的操作。取值：RotateSecret。
SecretName	String	是	RdsSecret/Mysql5.4/MyCred	凭据名称或凭据资源名称（ARN）。说明访问其他阿里云账号下的凭据时，必须输入凭据ARN。凭据ARN的格式为`acs:kms:${region}:${account}:secret/${secret-name}`。
VersionId	String	是	000000123	轮转后的新凭据版本的版本号。说明版本号用于保证请求的幂等性。KMS使用版本号来防止您的应用在请求失败后进行重试时，意外创建重复的版本。如果相同的版本号已经存在，轮转的请求会被忽略，服务端会返回成功。

返回数据

名称	类型	示例值	描述
VersionId	String	000000123	轮转后的新凭据版本的版本号。
SecretName	String	RdsSecret/Mysql5.4/MyCred	凭据名称。
RequestId	String	10257c86-269d-43aa-aaf3-90ed4144bb7c	本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。
Arn	String	acs:kms:cn-hangzhou:154035569884****:secret/RdsSecret/Mysql5.4/MyCred	凭据ARN。

关于公共请求参数的详情，请参见公共参数。

示例

请求示例

http(s)://[Endpoint]/?Action=RotateSecret
&SecretName=RdsSecret/Mysql5.4/MyCred
&VersionId=000000123
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RotateSecretResponse>
    <VersionId>000000123</VersionId>
    <SecretName>RdsSecret/Mysql5.4/MyCred</SecretName>
    <RequestId>10257c86-269d-43aa-aaf3-90ed4144bb7c</RequestId>
    <Arn>acs:kms:cn-hangzhou:154035569884****:secret/RdsSecret/Mysql5.4/MyCred</Arn>
</RotateSecretResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VersionId" : "000000123",
  "SecretName" : "RdsSecret/Mysql5.4/MyCred",
  "RequestId" : "10257c86-269d-43aa-aaf3-90ed4144bb7c",
  "Arn" : "acs:kms:cn-hangzhou:154035569884****:secret/RdsSecret/Mysql5.4/MyCred"
}

错误码

HttpCode	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is not valid.	参数非法。

访问错误中心查看更多错误码。