文档中心

列出用户主密钥

最近更新时间：2023.06.21 16:55:00

首次发布时间：2021.11.24 19:45:10

描述
列出用户主密钥

请求业务参数

名称	类型	是否必选	示范值	描述
Action	String	是	DescribeKeys	接口名，取值：DescribeKeys
Version	String	是	2021-02-18	版本号，取值：2021-02-18
KeyringName	String	是	test_keyring-1	密钥环的别名。长度为 2 - 31 个字符合法字符：[a-zA-Z0-9-_]
CurrentPage	Integer	否	1	分页查找的页码，取值 >= 1
PageSize	Integer	否	20	分页查找的页面大小，取值：[1, 100]

返回业务参数

名称	类型	描述
PageInfo	PageInfo	分页信息
ResponseMetaData	ResponseMetaData	返回公共参数
Result	List<Key>	密钥元数据

请求示例

https://kms.volcengineapi.com?Action=DescribeKeys&Version=2021-02-18&KeyringName=test_keyring-1

返回示例

{
    "PageInfo":{
        "TotalCount":1,
        "PageSize":5,
        "CurrentPage":1,
        "Count":1
    },
    "ResponseMetadata":{
        "RequestId":"DBFD8037-904D-4DD2-9BDB-BDF743E545B5",
        "Action":"DescribeKeys",
        "Version":"2021-04-30",
        "Service":"kms",
        "Region":"cn-north-1"
    },
    "Result":{
        "Keys":[
            {
                "ID":"d24a9f14-1a8b-4393-b66e-b77b766b5735",
                "CreationDate":1625818017,
                "UpdateDate":1625818017591,
                "KeyName":"demo_key",
                "KeySpec":"SYMMETRIC_256",
                "Description":"",
                "KeyState":"Enable",
                "KeyUsage":"ENCRYPT_DECRYPT",
                "ProtectionLevel":"SOFTWARE"
            }
        ]
    }
}

密钥管理系统

列出用户主密钥