立即轮转凭据。
接口说明
-
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。
-
同一阿里云账号每小时最多轮转 50 次。
-
RotateSecret 接口不支持轮转通用凭据。
说明 仅支持自动轮转的凭据类型使用本接口。如需对通用凭据进行轮转,请使用 PutSecretValue 接口。
本文将提供一个示例,将名称为RdsSecret/Mysql5.4/MyCred
的凭据进行手动轮转,轮转后新的凭据版本为000000123
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SecretName | string | 是 | 凭据名称或凭据资源名称(ARN)。 说明
访问其他阿里云账号下的凭据时,必须输入凭据 ARN。凭据 ARN 的格式为 acs:kms:${region}:${account}:secret/${secret-name} 。
| RdsSecret/Mysql5.4/MyCred |
VersionId | string | 是 | 轮转后的新凭据版本的版本号。 说明
版本号用于保证请求的幂等性。KMS 使用版本号来防止您的应用在请求失败后进行重试时,意外创建重复的版本。如果相同的版本号已经存在,轮转的请求会被忽略,服务端会返回成功。
| 000000123 |
返回参数
关于公共请求参数的详情,请参见公共参数。
示例
正常返回示例
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"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is not valid. | 参数非法。 |
404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | - |
访问错误中心查看更多错误码。