DescribeKey - 查询用户主密钥--密钥管理系统-火山引擎

文档中心

立即注册

导航

DescribeKey - 查询用户主密钥

最近更新时间：2024.08.29 17:27:47首次发布时间：2024.08.29 17:27:47

查询用户主密钥

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeKey	要执行的操作，取值：DescribeKey。
Version	String	是	2021-02-18	API的版本，取值：2021-02-18。
KeyringName	String	是	keyring-test	密钥环名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]
KeyName	String	是	key-test	主密钥名称，长度为 2 - 31 个字符。合法字符：[a-zA-Z0-9-_]

返回参数

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

参数	类型	示例值	描述
Key	Object	Key 结构的数据	主密钥信息

请求示例

GET /?Action=DescribeKey&Version=2021-02-18&KeyringName=demo&KeyName=demo HTTP/1.1
Host: kms.volcengineapi.com
X-Date: 20240708T021200Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240708101218071139091045786C7A",
    "Action": "DescribeKey",
    "Version": "2021-02-18",
    "Service": "kms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Key": {
      "ID": "0324d9b3-c5d9-4b6f-94e7-884010a16fee",
      "CreationDate": 1642732307,
      "UpdateDate": 1642732307264,
      "KeyName": "demo",
      "KeySpec": "SYMMETRIC_256",
      "Description": "demo",
      "KeyState": "Enable",
      "KeyUsage": "ENCRYPT_DECRYPT",
      "ProtectionLevel": "SOFTWARE",
      "RotationState": "Enable",
      "LastRotationTime": "2022-01-21T10:31:47.264+08:00",
      "ScheduleRotationTime": "2023-01-21T10:31:47.264+08:00",
      "Trn": "trn:kms:cn-beijing:2100056381:keyrings/demo/keys/demo"
    }
  }
}

错误码

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

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