You need to enable JavaScript to run this app.
导航
DescribeSecret - 查询凭据
最近更新时间:2024.10.18 12:34:31首次发布时间:2024.10.18 12:34:31

查询凭据

调试

请求参数

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

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

DescribeSecret

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

Version
String

2021-02-18

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

SecretName
String

secret-9527

凭据名称,长度为 2 ~ 31 个字符。合法字符:[a-zA-Z0-9-_]

返回参数

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

参数
类型
示例值
描述
Secret
Object

{
"ID": "d24a9f14-1a8b-4393-b66e-b77b766b6666",
"CreationDate": 1625818017,
"UpdateDate": 1625818017591,
"SecretName": "secret-9527",
"UID": "2100000282",
"Trn": "trn:kms:cn-beijing:2100000282:secrets/secret-9527",
"ProjectName": "default",
"Description": "test",
"SecretType": "Generic",
"Managed": false,
"ExtendedConfig": "",
"RotationState": "None",
"RotationInterval": 0
}

查询的凭据信息

请求示例

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


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240808100105207033003140DB67B3",
    "Action": "DescribeSecret",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Secret": {
      "ID": "d24a9f14-1a8b-4393-b66e-b77b766b6666",
      "CreationDate": 1625818017,
      "UpdateDate": 1625818017591,
      "SecretName": "secret-9527",
      "UID": "2100000282",
      "Trn": "trn:kms:cn-beijing:2100000282:secrets/secret-9527",
      "ProjectName": "default",
      "Description": "test",
      "SecretType": "Generic",
      "Managed": false,
      "ExtendedConfig": "",
      "RotationState": "None",
      "RotationInterval": 0
    }
  }
}

错误码

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

状态码
错误码
错误信息
说明
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.
404
Not Found
Not found %s [%s].
500
UndefinedError
Undefined Internal Error. Pls Contact With Admin.