创建凭据的定时删除任务 - DeleteSecretForSchedule
功能介绍
指定延迟删除时间,创建删除凭据的定时任务,可设置7~30天的的延迟删除时间
接口约束
处于“定时删除”状态的凭据对象无法更新元数据信息,也无法查看凭据值
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/{project_id}/secrets/{secret_name}/scheduled-deleted-tasks/create
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32 默认取值: 不涉及 |
| secret_name | 是 | String | 参数解释: 凭据名称 约束限制: 不涉及 取值范围: 需要满足正则表达式:^[a-zA-Z0-9_-]{1,64}$ 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。使用AK、SK等认证方式,此处非必选 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| recovery_window_in_days | 是 | Integer | 参数解释: 创建定时删除凭据的任务,且指定延迟删除的天数 约束限制: 不涉及 取值范围: 7~30 默认取值: 30 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| secret | Secret object | 参数解释: 凭据详细信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 凭据的资源标识符 取值范围: 不涉及 |
| name | String | 参数解释: 凭据名称 取值范围: 不涉及 |
| state | String | 参数解释: 凭据状态 取值范围: |
| 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 | 参数解释: 凭据类型 取值范围: |
| auto_rotation | Boolean | 参数解释: 自动轮转 取值范围: true 开启, false 关闭(默认) |
| rotation_period | String | 参数解释: 轮转周期 取值范围: 4小时-8,760小时 (365天) |
| rotation_config | String | 参数解释: 轮转配置 取值范围: 说明:当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 | 参数解释: 下一次轮转时间戳 取值范围: 不涉及 |
| last_used_time | Long | 参数解释: 最近一次获取凭据值的时间 取值范围: 不涉及 |
| event_subscriptions | Array of strings | 参数解释: 凭据订阅的事件列表,当前最大可订阅一个事件。当事件包含的基础事件触发时,通知消息将发送到事件对应的通知主题 取值范围: 不涉及 |
| enterprise_project_id | String | 参数解释: 企业项目ID 取值范围: 不涉及 |
| rotation_func_urn | String | 参数解释: FunctionGraph函数的urn 取值范围: 不涉及 |
| domain_id | String | 参数解释: 凭据所属的租户的id 取值范围: 不涉及 |
| replica_type | String | 参数解释: 多 Region 凭据类型 取值范围: |
| replicas | Array of Replica objects | 参数解释: 副本凭据信息 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 凭据资源标识符 取值范围: 不涉及 |
| kms_key_id | String | 参数解释: 用于加密凭据值的KMS密钥的ID 取值范围: 不涉及 |
| project_id | String | 参数解释: 凭据所属的 project_id 取值范围: 不涉及 |
| region | String | 参数解释: 凭据所属的 region 名称 取值范围: 不涉及 |
| replica_type | String | 参数解释: 多 Region 凭据类型 取值范围: |
| status | String | 参数解释: 副本凭据同步状态 取值范围: |
| created_at | Long | 参数解释: 创建时间戳 取值范围: 不涉及 |
| updated_at | Long | 参数解释: 更新时间戳 取值范围: 不涉及 |
请求示例
创建凭据定时删除任务,15天后进行删除
{
"recovery_window_in_days" : 15
} 响应示例
状态码: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 | 请求已成功 |
错误码
请参见错误码。