轮转凭据 - RotateSecret
功能介绍
立即执行轮转凭据。在指定的凭据中，创建一个新的凭据版本，用于加密存储后台随机产生的凭据值。同时将新创建的凭据版本标记为SYSCURRENT状态。
接口约束
RotateSecret接口不支持轮转通用凭据。
用户账号拥有以下权限：
rds修改数据库密码
查询密钥信息
查询密钥列表
创建数据密钥
解密数据密钥。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
csms:secret:rotate
Write
secretName *
-
csms:Type
-
g:EnterpriseProjectId
-
g:ResourceTag/<tag-key>
-
- rds:password:update
- kms:cmk:createGrant
- kms:cmk:retireGrant
-
URI
POST /v1/{project_id}/secrets/{secret_name}/rotate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
secret_name |
是 |
String |
凭据名称。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
version_id |
String |
凭据的版本号标识符。 |
|
secret_name |
String |
凭据的名称。 |
|
rotation_task_id |
String |
凭据轮转任务ID。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：502
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
状态码：504
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
ErrorDetail object |
错误信息返回体。 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"rotation_task_id" : "a71a4b47-6cac-4f11-92c1-21a165bb6401"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
认证失败 |
|
404 |
资源不存在，资源未找到 |
|
500 |
服务内部错误 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
504 |
网关超时 |
错误码
请参见错误码。
