更新凭据 - UpdateSecret

功能介绍

更新指定凭据的元数据信息。

接口约束

此接口仅能修改凭据的元数据信息，无法修改凭据值。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
csms:secret:update
Write
secretName *
csms:Type
csms:KmsKeyId
g:EnterpriseProjectId
g:ResourceTag/<tag-key>
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
csms:secret:update	Write	secretName *	csms:Type csms:KmsKeyId g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。
secret_name	是	String	凭据名称。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
kms_key_id	否	String	用于加密保护凭据值的KMS主密钥ID。更新凭据的主密钥后，仅新创建的凭据版本使用更新后的主密钥ID加密，之前的凭据版本依旧使用之前的主密钥ID解密。
description	否	String	凭据的描述信息。约束：2048字节。
auto_rotation	否	Boolean	自动轮转取值：true 开启 false 关
rotation_period	否	String	轮转周期约束：6小时-8,760小时（365天）类型：Integer[unit] ，Integer表示时间长度。unit表示时间单位，d（天）、h（小时）、m（分钟）、s（秒）。例如 1d 表示一天，24h也表示一天说明：当开启自动轮转时，必须填写该值
event_subscriptions	否	Array of strings	凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题。
rotation_func_urn	否	String	FunctionGraph函数的urn。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
secret	Secret object	凭据对象。

表5 Secret
参数	参数类型	描述
id	String	凭据的资源标识符。
name	String	凭据名称。
state	String	凭据状态，取值如下： ENABLED：表示启用状态 DISABLED：表示禁用状态 PENDING_DELETE：表示待删除状态 FROZEN：表示冻结状态
kms_key_id	String	用于加密凭据值的KMS主密钥的ID值。
description	String	凭据的描述信息。
create_time	Long	凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数。
update_time	Long	凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。
scheduled_delete_time	Long	凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。凭据不在删除计划中时，本项值为null。
secret_type	String	凭据类型 COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS：RDS凭据。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代） RDS-FG：RDS凭据。专门针对RDS的凭据，用于存储RDS的账号信息。 GaussDB-FG：TaurusDB凭据。专门针对TaurusDB的凭据，用于存储TaurusDB的账号信息。
auto_rotation	Boolean	自动轮转取值：true 开启, false 关闭(默认)
rotation_period	String	轮转周期约束：6小时-8,760小时（365天）类型：Integer[unit] ，Integer表示时间长度。unit表示时间单位，d（天）、h（小时）、m（分钟）、s（秒）。例如 1d 表示一天，24h也表示一天说明：当开启自动轮转时，必须填写该值
rotation_config	String	轮转配置约束：范围不超过1024个字符。当secret_type为RDS-FG、GaussDB-FG时，配置为{"InstanceId":"","SecretSubType":""} 说明：当secret_type为RDS-FG、GaussDB-FG时，必须填写该值 InstanceId为实例ID,SecretSubType为轮转子类型，取值为：SingleUser，MultiUser。 SingleUser：指定轮转类型为单用户模式轮转，每次轮转将指定账号重置为新的口令。 MultiUser：指定轮转类型为双用户模式轮转，SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时，SYSPREVIOUS引用的账号口令会被重置为新的随机口令，随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用。
rotation_time	Long	轮转时间戳
next_rotation_time	Long	下一次轮转时间戳
event_subscriptions	Array of strings	凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题。
enterprise_project_id	String	企业项目ID
rotation_func_urn	String	FunctionGraph函数的urn。

状态码：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	错误描述

请求示例

更新凭据KMS密钥ID为test，描述为"update description"。

{
  "kms_key_id" : "test",
  "description" : "update description",
  "event_subscriptions" : [ "pocEvent2" ]
}

响应示例

状态码：200

请求已成功

{
  "secret" : {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "name" : "test",
    "state" : "ENABLED",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "description" : "description",
    "create_time" : 1581507580000,
    "update_time" : 1581507580000,
    "scheduled_delete_time" : 1581507580000,
    "secret_type" : "RDS-FG",
    "auto_rotation" : true,
    "rotation_config" : "{'InstanceId':'indstance id','SecretSubType':'MultiUser'}",
    "rotation_period" : "1d",
    "rotation_time" : 1668567940000,
    "next_rotation_time" : 1668629140000,
    "event_subscriptions" : [ "pocEvent" ],
    "rotation_func_urn" : "urn:fss:{region}:46b6f338fc3445b8846c71dfb1fbxxxx:function:default:test2-0:latest"
  }
}

状态码

状态码	描述
200	请求已成功
400	请求参数有误
401	被请求的页面需要用户名和密码
403	认证失败
404	资源不存在，资源未找到
500	服务内部错误
502	请求未完成。服务器从上游服务器收到一个无效的响应
504	网关超时