DescribeKeys - 列出用户主密钥--密钥管理系统-火山引擎

文档中心

立即注册

导航

DescribeKeys - 列出用户主密钥

最近更新时间：2024.08.29 17:21:49首次发布时间：2024.08.29 17:21:49

列出用户主密钥

调试

API Explorer

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

去调试

请求参数

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

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

返回参数

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

参数	类型	示例值	描述
PageInfo	Object	PageInfo 结构的数据	分页信息
Keys	Array of Object	Key 结构的数据列表	主密钥列表信息

请求示例

GET /?Action=DescribeKeys&Version=2021-02-18&KeyringName=demo&CurrentPage=1&PageSize=5 HTTP/1.1
Host: kms.volcengineapi.com
X-Date: 20240707T153816Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240707/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202407072338460550250711642E5896",
    "Action": "DescribeKeys",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageInfo": {
      "TotalCount": 1,
      "PageSize": 5,
      "CurrentPage": 1,
      "Count": 1
    },
    "Keys": [
      {
        "ID": "d24a9f14-1a8b-4393-b66e-b77b766b5735",
        "CreationDate": 1625818017,
        "UpdateDate": 1625818017591,
        "KeyName": "demo",
        "KeySpec": "SYMMETRIC_256",
        "Description": "demo",
        "KeyState": "Enable",
        "KeyUsage": "ENCRYPT_DECRYPT",
        "ProtectionLevel": "SOFTWARE"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息
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].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.