ListClientKeys - Key Management Service - Alibaba Cloud Documentation Center

Queries a list of client keys

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AapName	string	No	The name of the application access point (AAP).	aap_test

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	2312e45f-b2fa-4c34-ad94-3eca50932916
ClientKeys	array<object>	A list of client keys.
ClientKey	object	A list of client keys.
ClientKeyId	string	The ID of the client key.	KAAP.66abf237-63f6-4625-b8cf-47e1086e****
CreateTime	string	The time when the client key was created.	2023-08-31T09:14:38Z
PublicKeyData	string	The public key of the client key.	-----BEGIN CERTIFICATE-----\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----
KeyAlgorithm	string	The private key algorithm of the client key.	RSA_2048
NotBefore	string	The beginning of the validity period of the client key.	2023-08-31T17:14:33Z
NotAfter	string	The end of the validity period of the client key.	2028-08-31T17:14:33Z
KeyOrigin	string	The provider of the client key. Currently, only KMS is supported. The value is fixed as KMS_PROVIDED.	KMS_PROVIDED
AapName	string	The name of the AAP.	aap_test

Examples

Sample success responses

JSONformat

{
  "RequestId": "2312e45f-b2fa-4c34-ad94-3eca50932916",
  "ClientKeys": [
    {
      "ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
      "CreateTime": "2023-08-31T09:14:38Z",
      "PublicKeyData": "-----BEGIN CERTIFICATE-----\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----",
      "KeyAlgorithm": "RSA_2048",
      "NotBefore": "2023-08-31T17:14:33Z",
      "NotAfter": "2028-08-31T17:14:33Z",
      "KeyOrigin": "KMS_PROVIDED",
      "AapName": "aap_test"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.