ListKeys - 查询调用者在调用地域的所有主密钥ID_密钥管理服务(KMS)-阿里云帮助中心

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	当前页数。取值范围：大于 0。默认值：1。	1
PageSize	integer	否	每页返回值的个数。取值范围：1~100。默认值：10。	10
Filters	string	否	主密钥过滤器。由 Key-Values 键值对组成，长度为 0~10。 Key 描述：需要过滤的属性。类型：String。 Values 描述：期望过滤后包含的值。类型：String 数组。长度：0~10。取值： Key 取值为 KeyState 时表示密钥状态。Vaule 取值为 Enabled（启用）、Disabled（禁用）、PendingDeletion（待删除）或 PendingImport（待导入）。 Key 取值为 KeySpec 时表示密钥类型。Vaule 取值为 Aliyun_AES_256、Aliyun_SM4、RSA_2048、EC_P256、EC_P256K、EC_SM2、Aliyun_SM4。说明：仅在支持托管密码机且已通过国密局商用密码检测认证的地域可以创建 EC_SM2 和 Aliyun_SM4 类型的密钥，地域详情请参见支持的地域。如果您所选择地域不支持 EC_SM2 和 Aliyun_SM4，指定这两个参数将被忽略。 Key 取值为 KeyUsage 时表示密钥用途。Vaule 取值为 ENCRYPT/DECRYPT（数据加密和解密）、SIGN/VERIFY （产生和验证数字签名）。 Key 取值为 ProtectionLevel 时表示密钥保护等级。Vaule 取值为 SOFTWARE（软件）、HSM（硬件）。说明：HSM 保护等级仅在特定地域支持，地域详情请参见支持的地域。如您所选择地域不支持 HSM，指定该参数将被忽略。 Key 取值为 CreatorType 时表示创建者类型。Vaule 取值为 User（获取由用户创建的主密钥）、Service （获取由用户授权其他云产品自动创建的主密钥）。 Key 取值为 DKMSInstanceId 时表示 KMS 实例 ID。Vaule 请按照实际填写。 Key 取值为 keyId 时表示密钥 ID。Vaule 请按照实际填写。 Key 取值为 AliasName 时表示密钥别名。Vaule 请按照实际填写。 Key 取值为 Creator 时表示密钥创建者。Vaule 请按照实际填写。 Key 取值为 TagKey 时表示密钥标签中的 Key。Vaule 请按照实际填写。 Key 取值为 TagValue 时表示密钥标签中的 Value。Vaule 请按照实际填写。 Filters 不同 Key 之间的逻辑关系为 AND，同一个 Key 中的多个 Value 之间的逻辑关系为 OR。例如：输入 `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]` 时，语义为： `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)。`	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前页数。	1
PageSize	integer	每页返回值的个数。	10
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	8252db58-2036-408c-a3d5-56e656dc2551
TotalCount	integer	主密钥的总数。	3
Keys	object
Key	array<object>	主密钥。
	object	主密钥。
KeyId	string	主密钥的全局唯一标识符。	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
KeyArn	string	主密钥的 ARN。	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "TotalCount": 3,
  "Keys": {
    "Key": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "KeyArn": "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。