DescribeSecretVersions - 列出凭据版本--密钥管理系统-火山引擎

文档中心

立即注册

导航

DescribeSecretVersions - 列出凭据版本

最近更新时间：2024.10.18 12:37:29首次发布时间：2024.10.18 12:37:29

列出凭据版本

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeSecretVersions	要执行的操作，取值：DescribeSecretVersions。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
SecretName	String	是	secret-9527	凭据名称，长度为 2 ~ 31 个字符。合法字符：[a-zA-Z0-9-_]
CurrentPage	Integer	否	1	分页查找的页码，取值 >= 1
PageSize	Integer	否	20	分页查找的页面大小，取值：[1, 100]

返回参数

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

参数	类型	示例值	描述
SecretVersions	Array of Object	[ { "VersionID": "54487470-102a-4f35-bfb1-b819e78f7579", "VersionStage": "CURRENT", "CreationDate": 1723104729 } ]	凭据版本信息
PageInfo	Object	{ "TotalCount": 1, "PageSize": 20, "CurrentPage": 1, "Count": 1 }	分页信息

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024081110441815424409905636A85B",
    "Action": "DescribeSecretVersions",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "SecretVersions": [
      {
        "VersionID": "54487470-102a-4f35-bfb1-b819e78f7579",
        "VersionStage": "CURRENT",
        "CreationDate": 1723104729
      }
    ],
    "PageInfo": {
      "TotalCount": 1,
      "PageSize": 20,
      "CurrentPage": 1,
      "Count": 1
    }
  }
}

错误码

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

状态码	错误码	错误信息
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.