更新时间:2026-05-20 GMT+08:00
分享

恢复凭据对象 - UploadSecretBlob

功能介绍

通过上传凭据备份文件,恢复凭据对象

接口约束

此接口返回的信息为凭据的元数据信息,不包含凭据值

调用方法

请参见如何调用API

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    csms:secret:create

    Write

    secretName *

    • csms:Type

    • csms:KmsKeyId

    -

    kms:cmk:decryptDataKey

    -

    • g:EnterpriseProjectId

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

POST /v1/{project_id}/secrets/restore

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

secret_blob

String

参数解释:

将指定凭据对象进行备份后得到的凭据备份文件,备份文件包含有凭据当前所有的凭据版本信息,备份文件经过加密与编码,内容不可直接读

约束限制:

仅能恢复同区域、同账号下下载的备份文件

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码: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

参数解释:

轮转周期

取值范围:

4小时-8,760小时 (365天)

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

参数解释:

下一次轮转时间戳

取值范围:

不涉及

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 凭据类型

取值范围:

  • STANDALONE:表示当前凭据没有 多Region 副本

  • PRIMARY:表示当前凭据有多 Region 副本,当前凭据为主凭据

  • REPLICA:表示当前凭据有多 Region 副本,当前凭据为副本凭据

replicas

Array of Replica objects

参数解释:

副本凭据信息

取值范围:

不涉及

表6 Replica

参数

参数类型

描述

id

String

参数解释:

凭据资源标识符

取值范围:

不涉及

kms_key_id

String

参数解释:

用于加密凭据值的KMS密钥的ID

取值范围:

不涉及

project_id

String

参数解释:

凭据所属的 project_id

取值范围:

不涉及

region

String

参数解释:

凭据所属的 region 名称

取值范围:

不涉及

replica_type

String

参数解释:

多 Region 凭据类型

取值范围:

  • PRIMARY:当前凭据为主凭据

  • REPLICA:当前凭据为副本凭据

status

String

参数解释:

副本凭据同步状态

取值范围:

  • IN_PROGRESS:副本凭据待同步

  • IN_SYNC:副本与主凭据同步

  • FAILED:副本凭据与主凭据同步失败

created_at

Long

参数解释:

创建时间戳

取值范围:

不涉及

updated_at

Long

参数解释:

更新时间戳

取值范围:

不涉及

请求示例

上传凭据备份文件

{
  "secret_blob" : ")CloudSecretManagementBackupV1.comeyJraWQiOiI5ZjNlZmRjNS0zZjVlLTRiZWQtYThkMS05NjE2ZTUwNDQzYWIiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.CtrOcFMSeW_qMdQjgKzNaWtC6hkSTdjOSMSr2IOKNa8OpbJH8rOaCt9l4LYLHKw8CF70YLWOODgaYrLiWuHgdR-O9hlALkT6CbXxJ-Cbmf6qpJF61kXKHX4TBe6-oV8t4PaPaSDDR_oeyt4Xl2EOOlHxs9PnU1st9Fkd7wOHNa4ueM16Ze5ICEdQK3cN1hnelid0zlb1qq58KhsSroNeI8B5RnoYDB-0eiFWD0XWJLppgkLnewXpuPLmLN_c558yUQ0u0VoUyBGB6EFePPbbT-Z1_LUCSRyiP9Y2S0Vz5jzzeabWZ4vZkW8JX57Wc-onHplUpsUUpIqcdHLjp40NEQ.VtA6Sg--jeA1QavYxY9z7Q.Mr6dLyontoJCaDaRFMAYg_qUdEPzd-aIIrCHWH7wvYayNpSFUjR5QJd3XPpGGy93y22jN-DoHZHclgMeureQwKq39QQF0xIdRqhOR2Lxy69PkgRaNtpz7ikLOlsbjh1wd7mbSmyolsK_0t1X9OlvOSmUMjxUXpXLzqLXxPY0R_MUxEanHb3V_vsLArF9sN1X7Km-fdUKXTV1EzVUq1eC5aSYqg3rGkLHPHG6lPXOetPWNsVCE1bX0Voh0XnlyFLSSoYzX45l04hR8JXgcP42FXfD7GugcNi7jTKuvxu4l2Q2v7wnk"
}

响应示例

状态码: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

请求已成功

错误码

请参见错误码

相关文档