调用本接口导出指定凭据的备份数据,用于凭据备份或迁移场景。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | BackupSecret | 要执行的操作,取值:BackupSecret。 |
Version | String | 是 | 2021-02-18 | API的版本,取值:2021-02-18。 |
SecretName | String | 是 | secret-9527 | 凭据名称,长度为 2 ~ 128 个字符。合法字符:[a-zA-Z0-9/_+=.@-]。可通过 CreateSecret 创建凭据时指定,或通过 DescribeSecrets 查询获取。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
SecretDataKey | String | C3UuDNBwR8eGeh4MpKp0bQAAY/IF0N+VFVlzDdbuKAaWYN8KxwbN9cqKB9d34lbeKFKPRGia9Egv/6PASfbgua7IG+ilsUOGkCTsqmvYcwGo/9prXDEutiThS6GOo/eenGpCzHYLV/p5TgeuzNc= | 加密凭据值的数据密钥密文,Base64 编码 |
BackupData | String | {} | 导出的 Secret 全量数据,JSON 格式 |
Signature | String | GHblfcSOT2aewMP5ZslQnSk6aM1R1WA4HpK8K+N/wGM= | BackupData 的签名值,Base64 编码 |
GET /?Action=BackupSecret&Version=2021-02-18&SecretName=secret-9527 HTTP/1.1 Host: kms.cn-beijing.volcengineapi.com X-Date: 20240811T054823Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240811/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{ "ResponseMetadata": { "RequestId": "2024081211284518805909219232CE2B", "Action": "BackupSecret", "Version": "2021-02-18", "Service": "kms", "Region": "cn-beijing" }, "Result": { "SecretDataKey": "C3UuDNBwR8eGeh4MpKp0bQAAY/IF0N+VFVlzDdbuKAaWYN8KxwbN9cqKB9d34lbeKFKPRGia9Egv/6PASfbgua7IG+ilsUOGkCTsqmvYcwGo/9prXDEutiThS6GOo/eenGpCzHYLV/p5TgeuzNc=", "BackupData": "{}", "Signature": "GHblfcSOT2aewMP5ZslQnSk6aM1R1WA4HpK8K+N/wGM=" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | InvalidParameter | 请求参数格式、类型或取值不合法,请根据参数说明检查并修正请求。 |
403 | AccessDenied | 当前账号或子账号缺少执行该操作所需权限,请检查 IAM 授权策略。 |
403 | Reject.Throttling.Action | 接口级请求频率超过限制,请降低请求速率后重试。 |
404 | Not Found | 指定资源不存在或当前账号无权访问,请检查资源 ID、名称和地域是否正确。 |
500 | UndefinedError | 服务内部错误,请稍后重试;如持续出现,请联系技术支持。 |