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

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。
本接口仅支持通用凭据，支持以下操作：
- 为指定的凭据版本新增一个版本状态。
- 将指定的凭据版本的版本状态移除。
- 将指定的凭据版本的版本状态移除，并绑定到其他凭据版本上。
每个通用凭据的版本状态总数不能超过 8 个。

本文将提供一个示例，更新名为secret001凭据的版本状态，将ACSCurrent版本状态用于标记002版本。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SecretName	string	是	凭据名称或凭据资源名称（ARN）。说明访问其他阿里云账号下的凭据时，必须输入凭据 ARN。凭据 ARN 的格式：`acs:kms:${region}:${account}:secret/${secret-name}`。	secret001
VersionStage	string	是	凭据的版本状态。场景一：为指定的凭据版本新增一个版本状态。输入本参数、MoveToVersion，不输入 RemoveFromVersion。本参数取值为 ACSCurrent 、ACSPrevious 或自定义状态。场景二：将指定的凭据版本的版本状态移除。输入本参数、RemoveFromVersion，不输入 MoveToVersion。本参数取值为自定义状态。说明 ACSCurrent 、ACSPrevious 为系统内置状态，不允许直接移除，只能从一个凭据版本移除并绑定到另一个凭据版本。场景三：将指定的凭据版本的版本状态移除，并绑定到其他凭据版本。输入本参数、MoveToVersion、RemoveFromVersion。本参数取值为 ACSCurrent 、ACSPrevious 或自定义状态。	ACSCurrent
RemoveFromVersion	string	否	凭据版本的版本号。表示将入参 VersionStage 指定的版本状态从该版本号移除。说明 RemoveFromVersion 和 MoveToVersion 至少指定其中一个参数。	001
MoveToVersion	string	否	凭据版本的版本号。表示将入参 VersionStage 指定的版本状态绑定到该版本号。说明 RemoveFromVersion 和 MoveToVersion 至少指定其中一个参数。当 VersionStage 取值为 ACSCurrent 或 ACSPrevious 时，必须指定本参数。	002

返回参数

名称	类型	描述	示例值
	object
SecretName	string	凭据名称。	secret001
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	8cad259f-4d77-40ec-bbd7-b9c47a423bb9

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	some of the specified parameters "\" is not valid
400	Rejected.LimitExceeded	exceed secret limits error
400	Rejected.InvalidRequest	param mismatch
400	Rejected.UnsupportedOperation	secret stages in unnormal status
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
404	Forbidden.ResourceNotFound	Resource not found
409	Rejected.ResourceInDeleteWindow	secret in delete peroid

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

变更历史

更多信息，参考变更详情。