All Products
Search
Document Center

Key Management Service:ListClientKeys

更新時間:Oct 11, 2023

Queries a list of client keys

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

ListClientKeys

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

AapName

String

Yes

aap_test

The name of the application access point (AAP).

Response parameters

Parameter

Type

Example

Description

RequestId

String

2312e45f-b2fa-4c34-ad94-3eca50932916

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

ClientKeys

Array of ClientKey

A list of client keys.

ClientKeyId

String

KAAP.66abf237-63f6-4625-b8cf-47e1086e****

The ID of the client key.

CreateTime

String

2023-08-31T09:14:38Z

The time when the client key was created.

PublicKeyData

String

-----BEGIN CERTIFICATE-----\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----

The public key of the client key.

KeyAlgorithm

String

RSA_2048

The private key algorithm of the client key.

NotBefore

String

2023-08-31T17:14:33Z

The beginning of the validity period of the client key.

NotAfter

String

2028-08-31T17:14:33Z

The end of the validity period of the client key.

KeyOrigin

String

KMS_PROVIDED

The provider of the client key.

Currently, only KMS is supported. The value is fixed as KMS_PROVIDED.

AapName

String

aap_test

The name of the AAP.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListClientKeys
&AapName=aap_test
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.