列出用户主密钥
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeKeys | 要执行的操作,取值:DescribeKeys。 |
Version | String | 是 | 2021-02-18 | API的版本,取值:2021-02-18。 |
Filters | String | 否 | [{"Key":"KeyName","Values":["hello","world"]}] | 查询符合指定条件的密钥,由 Key-Values 键值对组成。 |
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": { | 分页信息 |
Keys | Array of Object | "Keys": [ | 主密钥列表信息 |
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 | |
403 | Reject.Throttling.Action | |
403 | AccessDenied | |
404 | Not Found | |
500 | UndefinedError |