更新凭据
功能介绍
更新指定凭据的元数据信息。
接口约束
此接口仅能修改凭据的元数据信息，无法修改凭据值。
URI
PUT /v1/{project_id}/secrets/{secret_name}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| secret_name | 是 | String | 凭据名称。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| kms_key_id | 否 | String | 用于加密保护凭据值的KMS主密钥ID。更新凭据的主密钥后，仅新创建的凭据版本使用更新后的主密钥ID加密，之前的凭据版本依旧使用之前的主密钥ID解密。 |
| description | 否 | String | 凭据的描述信息。 约束：2048字节。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| secret | Secret object | 凭据对象。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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。 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 502
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码： 504
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
更新凭据KMS密钥ID为test，描述为"update description"。
{
"kms_key_id" : "test",
"description" : "update description"
} 响应示例
状态码： 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
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
| 400 | 请求参数有误 |
| 401 | 被请求的页面需要用户名和密码 |
| 403 | 认证失败 |
| 404 | 资源不存在，资源未找到 |
| 500 | 服务内部错误 |
| 502 | 请求未完成。服务器从上游服务器收到一个无效的响应 |
| 504 | 网关超时 |
错误码
请参见错误码。
