更新时间:2023-05-22 GMT+08:00

更新凭据的版本状态

功能介绍

更新凭据的版本状态。

接口约束

  • 凭据的版本状态在同一凭据对象下仅能唯一标识一个版本,将版本状态设置到新版本上的同时,将自动从老版本上移除其对应的版本状态。没有任何版本状态标识的版本将被视为已弃用,可由凭据管理服务自动删除。
  • 凭据管理服务的每个凭据中最多可支持12个凭据版本状态,每个凭据版本状态同时仅能标识一个凭据版本。SYSCURRENT,SYSPREVIOUS为服务内建的凭据状态。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/secrets/{secret_name}/stages/{stage_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

secret_name

String

凭据名称。

stage_name

String

凭据版本状态的名称。满足 '^[a-zA-Z0-9._-]{1,64}$'

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

version_id

String

凭据的版本号标识符。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

stage

Stage object

凭据状态。

表5 Stage

参数

参数类型

描述

name

String

凭据的版本状态名称。

约束:最小长度1,最大长度64。

update_time

Long

凭据的版本状态更新的时间戳,时间戳,即从1970年1月1日至该时间的总秒数。

secret_name

String

凭据名称。

version_id

String

凭据的版本号标识符。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 502

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 504

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{
  "version_id" : "version_id"
}

响应示例

状态码: 200

请求已成功

{
  "stage" : {
    "name" : "name",
    "version_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "update_time" : 1581507580000,
    "secret_name" : "secret-name-demo"
  }
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在,资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码