You need to enable JavaScript to run this app.
密钥管理系统

密钥管理系统

请输入
  • 文档首页
    • 密钥管理系统API参考凭据管理GetSecretValue - 获取凭据值
复制全文
我的收藏
凭据管理
GetSecretValue - 获取凭据值
复制全文
我的收藏
GetSecretValue - 获取凭据值

获取凭据值

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

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

GetSecretValue

要执行的操作，取值：GetSecretValue。

Version
String
是

2021-02-18

API的版本，取值：2021-02-18。

SecretName
String
是

secret-9527

凭据名称，长度为 2 ~ 128 个字符。合法字符：[a-zA-Z0-9/_+=.@-]

VersionID
String
否

b58a7e97-3000-4e6e-90c4-c01958333717

需要获取的凭据值的版本号。如果为空，默认返回“CURRENT”标签的版本。

VersionName
String
否

v1

版本别名，长度为 2 ~ 128 个字符。合法字符：[a-zA-Z0-9/_+=.@-]

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
VersionID
String

b58a7e97-3000-4e6e-90c4-c01958333717

获取的凭据值的版本号

VersionName
String

v1

获取的凭据值的版本别名

VersionStage
String

CURRENT

获取的凭据值的版本标签

CreationDate
Long

1723284049

凭据版本创建时间

SecretValue
String

{"username":"root","password":"123456"}

获取的凭据值

请求示例 

GET /?Action=GetSecretValue&Version=2021-02-18&SecretName=secret-9527 HTTP/1.1
Host: kms.cn-beijing.volcengineapi.com
X-Date: 20240810T113459Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240810/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例 

{
  "ResponseMetadata": {
    "RequestId": "20240810193520028008060086B0B947",
    "Action": "GetSecretValue",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "VersionID": "b58a7e97-3000-4e6e-90c4-c01958333717",
    "VersionStage": "CURRENT",
    "CreationDate": 1723284049,
    "SecretValue": "{\"username\":\"root\",\"password\":\"123456\"}"
  }
}

错误码

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

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

The request parameter %s is invalid.

403
AccessDenied

User is not authorized to do this action

403
Reject.Throttling.Action

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

403
KMS_ServiceNotOpen

KMS service not open yet, please open the service and try again later.

403
SecretsManagerServiceNotOpen

Secrets Manager service not open yet. Please open the service and try again later.

用户没有开通 SecretsManager 服务

404
Not Found

Not found %s [%s].

500
UndefinedError

Undefined Internal Error. Pls Contact With Admin.

最近更新时间：2026.01.22 13:57:01
这个页面对您有帮助吗？
有用
有用
无用
无用