文档

UpdateSecretRotationPolicy

更新时间:

调用UpdateSecretRotationPolicy接口更新凭据自动轮转策略。

使用限制:UpdateSecretRotationPolicy接口不支持更新通用凭据的轮转策略。

说明 因通用凭据不支持设置自动轮转,所以本接口不支持。

凭据开启自动轮转后,首次自动轮转的时间为上次轮转时间加上轮转周期。如果该时间早于当前时间,将会立即开始首次自动轮转。

本文将提供一个示例,更新名称为RdsSecret/Mysql5.4/MyCred的凭据轮转策略。具体如下:

  • EnableAutomaticRotation设置为true,表示开启自动轮转。
  • RotationInterval设置为30d,表示设置轮转周期为30天。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateSecretRotationPolicy

要执行的操作。取值:UpdateSecretRotationPolicy

SecretName String RdsSecret/Mysql5.4/MyCred

凭据名称或凭据资源名称(ARN)。

说明 访问其他阿里云账号下的凭据时,必须输入凭据ARN。凭据ARN的格式为acs:kms:${region}:${account}:secret/${secret-name}
EnableAutomaticRotation Boolean true

是否开启自动轮转,取值:

  • true:开启自动轮转。
  • false(默认值):不开启自动轮转。
RotationInterval String 30d

自动轮转的周期。取值范围:168小时(7天)~8,760小时(365天)。

格式为integer[unit],其中integer表示时间长度,unit表示时间单位。

unit取值:d(天)、h(小时)、m(分钟)、s(秒)。例如:7d或者604,800s均表示7天的周期。

说明 当EnableAutomaticRotation取值为true时,必须设置该参数。反之,将忽略该参数。

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

返回数据

名称

类型

示例值

描述

SecretName String RdsSecret/Mysql5.4/MyCred

凭据名称。

RequestId String 2c124f6f-4210-499f-b88a-69f54004d2d8

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateSecretRotationPolicy
&SecretName=RdsSecret/Mysql5.4/MyCred
&EnableAutomaticRotation=true
&RotationInterval=30d
&公共请求参数

正常返回示例

XML格式

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

<UpdateSecretRotationPolicyResponse>
    <SecretName>RdsSecret/Mysql5.4/MyCred</SecretName>
    <RequestId>2c124f6f-4210-499f-b88a-69f54004d2d8</RequestId>
</UpdateSecretRotationPolicyResponse>

JSON格式

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

{
  "SecretName" : "RdsSecret/Mysql5.4/MyCred",
  "RequestId" : "2c124f6f-4210-499f-b88a-69f54004d2d8"
}

错误码

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