Retrieves information about a client key.
Operation description
For information about the access policy required for a RAM user or RAM role to call this operation, see Resource Access Management.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientKeyId |
string |
Yes |
The ID of the client key. |
KAAP.66abf237-63f6-4625-b8cf-47e1086e**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The details of the client key. |
||
| RequestId |
string |
The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues. |
63d849a6-045b-4a57-ad9f-c5f756cea9e9 |
| 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 |
| KeyAlgorithm |
string |
The algorithm of the private key for the client key. |
RSA_2048 |
| KeyOrigin |
string |
The creator of the client key. Currently, client keys are generated only by KMS. The value is `KMS_PROVIDED`. |
KMS_PROVIDED |
| PublicKeyData |
string |
The content of the public key for the client key. |
-----BEGIN CERTIFICATE-----\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE----- |
| NotAfter |
string |
The time when the client key expires. |
2028-08-31T17:14:33Z |
| NotBefore |
string |
The time when the validity period of the client key starts. |
2023-08-31T17:14:33Z |
| AapName |
string |
The name of the application access point (AAP). |
aap_test |
Examples
Success response
JSON format
{
"RequestId": "63d849a6-045b-4a57-ad9f-c5f756cea9e9",
"ClientKeyId": "KAAP.66abf237-63f6-4625-b8cf-47e1086e****",
"CreateTime": "2023-08-31T09:14:38Z",
"KeyAlgorithm": "RSA_2048",
"KeyOrigin": "KMS_PROVIDED",
"PublicKeyData": "-----BEGIN CERTIFICATE-----\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----",
"NotAfter": "2028-08-31T17:14:33Z",
"NotBefore": "2023-08-31T17:14:33Z",
"AapName": "aap_test"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.