全部產品
Search
文件中心

:UpdateSecretRotationPolicy

更新時間:Jan 22, 2025

調用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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。