You need to enable JavaScript to run this app.
导航
DescribeKeys - 列出用户主密钥
最近更新时间:2025.02.05 16:25:29首次发布时间:2024.08.29 17:21:49
我的收藏
有用
有用
无用
无用

列出用户主密钥

调试

请求参数

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

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

DescribeKeys

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

Version
String

2021-02-18

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

Filters
String

[{"Key":"KeyName","Values":["hello","world"]}]

查询符合指定条件的密钥,由 Key-Values 键值对组成。
Key
描述:需要查询的属性。
类型:String。
取值:
KeyName:密钥名称。
KeySpec:密钥规格。
Description:密钥描述。
KeyState:密钥状态。
KeyUsage:密钥用途。
ProtectionLevel:密钥保护级别。
RotateState:密钥轮转状态。
Origin:密钥来源。
CreationDateRange:密钥创建的时间范围。
UpdateDateRange:密钥更新的时间范围。
Values
描述:属性的具体取值。
类型:String 列表。
容量:1~10。
取值说明:
Key 取值为 KeyName 时:支持模糊搜索,不区分大小写,示例:["hello","world"]。
Key 取值为 KeySpec 时:取值为 SYMMETRIC_256、SYMMETRIC_128、RSA_2048、RSA_3072、RSA_4096、EC_P256K、EC_P256、EC_P384、EC_P521、EC_SM2,区分大小写,示例:["SYMMETRIC_256","SYMMETRIC_128"]。
Key 取值为 Description 时:支持模糊搜索,不区分大小写,示例:["hello","world"]。
Key 取值为 KeyState 时:取值为 Enable、Disable、PendingDelete、Archived、PendingImport,区分大小写,示例:["Enable","PendingDelete"]。
Key 取值为 KeyUsage 时:取值为 ENCRYPT_DECRYPT、SIGN_VERIFY,区分大小写,示例:["ENCRYPT_DECRYPT","SIGN_VERIFY"]。
Key 取值为 ProtectionLevel 时:取值为 SOFTWARE、HSM,区分大小写,示例:["SOFTWARE","HSM"]。
Key 取值为 RotateState 时:取值为 Enable、Disable,区分大小写,示例:["Enable","Disable"]。
Key 取值为 Origin 时:取值为 CloudKMS、External,区分大小写,示例:["CloudKMS","External"]。
Key 取值为 CreationDateRange 时:必须填入开始时间和结束时间,示例:["2024-08-13 10:00:00","2024-08-14 10:00:00"]。
Key 取值为 UpdateDateRange 时:必须填入开始时间和结束时间,示例:["2024-08-13 10:00:00","2024-08-14 10:00:00"]。
Filters 同一个 Key 中的多个 Value 之间的逻辑关系为 OR,不同 Key 之间的逻辑关系为 AND。
例如:输入[{"Key":"KeyName", "Values":["hello","world"]},{"Key":"KeySpec", "Values":["EC_SM2"]}]时,语义为:(KeyName=hello OR KeyName=world) AND (KeySpec=EC_SM2)。

KeyringID
String

0324d9b3-c5d9-4b6f-94e7-884010a16fee

密钥环ID,二选一: KeyringName KeyringID

KeyringName
String

keyringName

密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]

CurrentPage
Integer

1

分页查找的页码,取值 >= 1

PageSize
Integer

1

分页查找的页面大小,取值:[1, 100]

返回参数

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

参数
类型
示例值
描述
PageInfo
Object

"PageInfo": {
"TotalCount": 1,
"PageSize": 5,
"CurrentPage": 1,
"Count": 1
}

分页信息

Keys
Array of Object

"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",
"MultiRegion": false
}
]

主密钥列表信息

请求示例

POST /?Action=DescribeKeys&Version=2021-02-18 HTTP/1.1
Host: kms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240923T150827Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240923/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Filters": "[{\"Key\":\"KeyName\",\"Values\":[\"hello\",\"world\"]}]",
  "KeyringName": "demo",
  "CurrentPage": 1,
  "PageSize": 20
}

返回示例

{
  "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",
        "MultiRegion": false
      }
    ]
  }
}

错误码

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

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