You need to enable JavaScript to run this app.
文档中心
密钥管理系统

密钥管理系统

复制全文
下载 pdf
凭据管理
RestoreSecret - 恢复凭据
复制全文
下载 pdf
RestoreSecret - 恢复凭据

调用本接口将备份的凭据数据恢复到当前或新的凭据中,通常用于凭据恢复或迁移场景。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

RestoreSecret

要执行的操作,取值:RestoreSecret。

Version
String
是

2021-02-18

API的版本,取值:2021-02-18。

SecretDataKey
String
是

C3UuDNBwR8eGeh4MpKp0bQAAY/IF0N+VFVlzDdbuKAaWYN8KxwbN9cqKB9d34lbeKFKPRGia9Egv/6PASfbgua7IG+ilsUOGkCTsqmvYcwGo/9prXDEutiThS6GOo/eenGpCzHYLV/p5TgeuzNc=

备份凭据时返回的数据密钥密文,Base64 编码

BackupData
String
是

{}

备份凭据时返回的 Secret 全量数据,JSON 格式

Signature
String
是

GHblfcSOT2aewMP5ZslQnSk6aM1R1WA4HpK8K+N/wGM=

备份凭据时返回的 BackupData 的签名值,Base64 编码

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=RestoreSecret&Version=2021-02-18 HTTP/1.1
Host: kms.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240811T065828Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240811/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "SecretDataKey": "C3UuDNBwR8eGeh4MpKp0bQAAY/IF0N+VFVlzDdbuKAaWYN8KxwbN9cqKB9d34lbeKFKPRGia9Egv/6PASfbgua7IG+ilsUOGkCTsqmvYcwGo/9prXDEutiThS6GOo/eenGpCzHYLV/p5TgeuzNc=",
  "BackupData": "{}",
  "Signature": "GHblfcSOT2aewMP5ZslQnSk6aM1R1WA4HpK8K+N/wGM="
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202408111458350352532021348F6125",
    "Action": "RestoreSecret",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter

The request parameter %s is invalid.

请求参数格式、类型或取值不合法,请根据参数说明检查并修正请求。

400
MissingParameter

The request is missing SecretDataKey parameter.

缺失参数

403
AccessDenied

User is not authorized to do this action

当前账号或子账号缺少执行该操作所需权限,请检查 IAM 授权策略。

403
Reject.Throttling.Action

The request of Action: %s upper limit is exceeded.

接口级请求频率超过限制,请降低请求速率后重试。

404
Not Found

Not found %s [%s].

指定资源不存在或当前账号无权访问,请检查资源 ID、名称和地域是否正确。

409
ProjectConflict

The secret [%s] already exists in one project.

资源已存在于指定项目或与项目内已有资源冲突,请检查项目和资源名称。

409
Conflict

The %s resource %s is conflict.

资源已存在或当前操作与已有资源状态冲突,请检查后重试。

500
UndefinedError

Undefined Internal Error. Pls Contact With Admin.

服务内部错误,请稍后重试;如持续出现,请联系技术支持。

502
InternalServiceError

Service has some internal Error. Pls Contact With Admin.

服务内部错误,请稍后重试;如持续出现,请联系技术支持。

最近更新时间:2026.09.03 18:02:14
这个页面对您有帮助吗?
有用
有用
无用
无用