调用UpdateSecretVersionStage接口更新凭据的版本状态_密钥管理服务(KMS)-阿里云帮助中心

本接口仅支持通用凭据，支持以下操作：

为指定的凭据版本新增一个版本状态。
将指定的凭据版本的版本状态移除。
将指定的凭据版本的版本状态移除，并绑定到其他凭据版本上。

本文将提供一个示例，更新名为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"
}

错误码

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