文档首页/ 密码安全中心 DEW/ API参考/ API/ 凭据管理服务/ 生命周期管理/ 轮转凭据 - RotateSecret
更新时间：2026-05-20 GMT+08:00
查看PDF
分享

轮转凭据 - 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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32

默认取值：

不涉及

secret_name

是

String

参数解释：

凭据名称

约束限制：

不涉及

取值范围：

需要满足正则表达式：^[a-zA-Z0-9_-]{1,64}$

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

version_id

String

参数解释：

凭据的版本号标识符

取值范围：

不涉及

secret_name

String

参数解释：

凭据的名称

取值范围：

不涉及

rotation_task_id

String

参数解释：

凭据轮转任务ID

取值范围：

不涉及

请求示例

无

响应示例

状态码：200

请求已成功

{
  "rotation_task_id" : "a71a4b47-6cac-4f11-92c1-21a165bb6401"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 生命周期管理

相关文档