調用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. | 參數非法。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?