RotateSecret - - 阿里雲

使用限制：

• 同一阿里雲帳號每小時最多輪轉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.	參數非法。

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