Key Management Service:ListKeys

Action

String

Yes

ListKeys

The operation that you want to perform. Set the value to ListKeys.

PageNumber

Integer

No

1

The page number.

Pages start from page 1.

Default value: 1.

PageSize

Integer

No

10

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

Filters

String

No

[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

The key filter. The filter consists of one or more key-values pairs. You can specify a maximum of 10 key-values pairs.

• Key

  • Description: the property that you want to filter.

  • Type: string.

  • Valid values:

    • KeyState: the status of the key.

    • KeySpec: the type of the key.

    • KeyUsage: the usage of the key.

    • ProtectionLevel: the protection level.

    • CreatorType: the type of the creator.

    • DKMSInstanceId: the ID of the KMS instance.

• Values

  • Description: the value to be included after filtering.

  • Format: string array.

  • Length: 0 to 10.

  • Valid values:

    • If Key is set to KeyState, the value can be Enabled, Disabled, PendingDeletion, or PendingImport.

    • If Key is set to KeySpec, the value can be Aliyun_AES_256, Aliyun_SM4, RSA_2048, EC_P256, EC_P256K, or EC_SM2.

      Note: You can create EC_SM2 or Aliyun_SM4 keys only in regions where State Cryptography Administration (SCA)-certified managed hardware security modules (HSMs) reside. For more information about the regions, see Supported regions. If your region does not support EC_SM2 and Aliyun_SM4, the two values are ignored if they are specified.

    • If Key is set to KeyUsage, the value can be ENCRYPT/DECRYPT or SIGN/VERIFY. ENCRYPT/DECRYPT indicates that the key is used to encrypt and decrypt data. SIGN/VERIFY indicates that the key is used to sign data and verify digital signatures.

    • If Key is set to ProtectionLevel, the value can be SOFTWARE (software) or HSM (hardware).

      You can set ProtectionLevel to HSM in only specific regions. For more information about the regions, see Supported regions. If the region does not support HSM, the value is ignored if the value is specified.

    • If Key is set to CreatorType, the value can be User or Service. User indicates that keys created by the current account are queried. Service indicates that keys automatically created by other cloud services authorized by the current account are queried.

    • If Key is set to DKMSInstanceId, the value is the ID of the KMS instance and is in the kst-xxx format.

The logical relationship between different keys is AND. The logical relationship between values of the Values field in a key-value pair is OR. Example:

[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]. In this example, the semantics are:

(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_ 256).

PageNumber

Integer

1

The page number.

PageSize

Integer

10

The number of entries per page.

RequestId

String

8252db58-2036-408c-a3d5-56e656dc2551

The ID of the request, which is used to locate and troubleshoot issues.

TotalCount

Integer

3

The total number of keys.