文档中心

列出密钥环

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

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

描述
列出租户的密钥环

请求业务参数

名称	类型	是否必选	示范值	描述
Action	String	是	DescribeKeyrings	接口名，取值：DescribeKeyrings
Version	String	是	2021-02-18	版本号，取值：2021-02-18
CurrentPage	Integer	否	1	分页查找的页码，取值 >= 1
PageSize	Integer	否	20	分页查找的页面大小，取值：[1, 100]

返回业务参数

名称	类型	示范值
PageInfo	PageInfo	分页信息
ResponseMetaData	ResponseMetaData	返回公共参数
Result	List<Keyring>	密钥环列表信息

请求示例

https://kms.volcengineapi.com?Action=DescribeKeyrings&Version=2021-02-18&CurrentPage=1&PageSize=5

返回示例

{
    "PageInfo":{
        "TotalCount":2,
        "PageSize":5,
        "CurrentPage":1,
        "Count":2
    },
    "ResponseMetadata":{
        "RequestId":"DBFD8037-904D-4DD2-9BDB-BDF743E545B5",
        "Action":"DescribeKeyrings",
        "Version":"2021-02-18",
        "Service":"kms",
        "Region":"cn-north-1"
    },
    "Result":{
        "Keyrings":[
            {
                "ID":"758cb40e-3bf2-4cff-88d5-f898e1d9cf27",
                "CreationDate":1626748349,
                "UpdateDate":1626748349045,
                "KeyringName":"demo",
                "KeyringType":"CustomKeyring",
                "Description":"demo keyring for test",
                "UID":"2100000282"
            },
            {
                "ID":"6859f1b4-9fe0-4237-84a4-e11c6ff4d85a",
                "CreationDate":1626604238,
                "UpdateDate":1626604238868,
                "KeyringName":"demo_keyringaaa",
                "KeyringType":"CustomKeyring",
                "Description":"demo keyring for test",
                "UID":"2100000282"
            }
        ]
    }
}

密钥管理系统

列出密钥环