You need to enable JavaScript to run this app.
Key Management System

Key Management System

Copy page
Download PDF
Secret manager
RestoreSecret - Restore secret
Copy page
Download PDF
RestoreSecret - Restore secret

Restore secret

Debug

Request parameters

The table below lists only the unique request parameters for this API and some common parameters. For more information, see common parameters.

Parameter
Type
Required
Example
Description
Action
String
yes

RestoreSecret

The action to perform, values: RestoreSecret.

Version
String
yes

2021-02-18

API version, value: 2021-02-18.

SecretDataKey
String
yes

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

Data key ciphertext returned when backing up secrets, Base64 encoded

BackupData
String
yes

{}

Full secret data returned when backing up the secret, in JSON format

Signature
String
yes

GHblfcSOT2aewMP5ZslQnSk6aM1R1WA4HpK8K+N/wGM=

The signature value of BackupData returned when backing up the secret, Base64 encoded

Response parameters

This interface has no unique return parameters. See return structure for more information.

Request example

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=" 
}

Return example

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

Error code

The table below lists error codes related to this interface and business logic. For public error codes, refer to the public error codes document.

Status Code
Error Code
Error message
Description
400
InvalidParameter

The request parameter %s is invalid.

403
Reject.Throttling.Action

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

403
AccessDenied

User is not authorized to do this action

404
Not Found

Not found %s [%s].

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.

Last updated: 2025.06.27 15:24:19