全部產品
Search
文件中心

:UpdateSecretVersionStage

更新時間:Jan 22, 2025

調用UpdateSecretVersionStage介面更新通用憑據的版本狀態。

本介面僅支援通用憑據,支援以下操作:

  • 為指定的憑據版本新增一個版本狀態。
  • 將指定的憑據版本的版本狀態移除。
  • 將指定的憑據版本的版本狀態移除,並綁定到其他憑據版本上。

本文將提供一個樣本,更新名為secret001憑據的版本狀態,將ACSCurrent版本狀態用於標記002版本。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱

類型

是否必選

樣本值

描述

Action String UpdateSecretVersionStage

要執行的操作。取值:UpdateSecretVersionStage

SecretName String secret001

憑據名稱或憑據資源名稱(ARN)。

說明 訪問其他阿里雲帳號下的憑據時,必須輸入憑據ARN。憑據ARN的格式為acs:kms:${region}:${account}:secret/${secret-name}
VersionStage String ACSCurrent

憑據的版本狀態。

情境一:為指定的憑據版本新增一個版本狀態。

輸入本參數、MoveToVersion,不輸入RemoveFromVersion。本參數取值為ACSCurrent 、ACSPrevious或自訂狀態。

情境二:將指定的憑據版本的版本狀態移除。

輸入本參數、RemoveFromVersion,不輸入MoveToVersion。本參數取值為自訂狀態。

說明 ACSCurrent 、ACSPrevious為系統內建狀態,不允許直接移除,只能從一個憑據版本移除並綁定到另一個憑據版本。
情境三:將指定的憑據版本的版本狀態移除,並綁定到其他憑據版本。

輸入本參數、MoveToVersion、RemoveFromVersion。本參數取值為ACSCurrent 、ACSPrevious或自訂狀態。

RemoveFromVersion String 001

憑據版本的版本號碼。表示將入參VersionStage指定的版本狀態從該版本號碼移除。

說明 RemoveFromVersion和MoveToVersion至少指定其中一個參數。
MoveToVersion String 002

憑據版本的版本號碼。表示將入參VersionStage指定的版本狀態綁定到該版本號碼。

說明
  • RemoveFromVersion和MoveToVersion至少指定其中一個參數。
  • 當VersionStage取值為ACSCurrent或ACSPrevious時,必須指定本參數。

返回資料

名稱

類型

樣本值

描述

SecretName String secret001

憑據名稱。

RequestId String 8cad259f-4d77-40ec-bbd7-b9c47a423bb9

本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=UpdateSecretVersionStage
&SecretName=secret001
&VersionStage=ACSCurrent
&RemoveFromVersion=001
&MoveToVersion=002
&公用請求參數

正常返回樣本

XML格式

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

<UpdateSecretVersionStageResponse>
    <SecretName>secret001</SecretName>
    <RequestId>8cad259f-4d77-40ec-bbd7-b9c47a423bb9</RequestId>
</UpdateSecretVersionStageResponse>

JSON格式

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

{
  "SecretName" : "secret001",
  "RequestId" : "8cad259f-4d77-40ec-bbd7-b9c47a423bb9"
}

錯誤碼

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