全部产品
Search
文档中心

密钥管理服务:GetClientKey

更新时间:Sep 08, 2023

获取一个应用身份凭证(ClientKey)信息。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String GetClientKey

系统规定参数。取值:GetClientKey

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

ClientKey的ID。

返回数据

名称

类型

示例值

描述

RequestId String 63d849a6-045b-4a57-ad9f-c5f756cea9e9

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

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

ClientKey的ID。

CreateTime String 2023-08-31T09:14:38Z

ClientKey的创建时间。

KeyAlgorithm String RSA_2048

ClientKey的私钥算法。

KeyOrigin String KMS_PROVIDED

ClientKey由谁生成。

目前仅支持由KMS生成,取值为KMS_PROVIDED。

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

ClientKey的公钥内容。

NotAfter String 2028-08-31T17:14:33Z

ClientKey的有效期结束时间。

NotBefore String 2023-08-31T17:14:33Z

ClientKey的有效期起始时间。

AapName String aap_test

应用接入点名称。

示例

请求示例

http(s)://[Endpoint]/?Action=GetClientKey
&ClientKeyId=KAAP.66abf237-63f6-4625-b8cf-47e1086e****
&公共请求参数

正常返回示例

XML格式

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

<GetClientKeyResponse>
    <RequestId>63d849a6-045b-4a57-ad9f-c5f756cea9e9</RequestId>
    <ClientKeyId>KAAP.66abf237-63f6-4625-b8cf-47e1086e****</ClientKeyId>
    <CreateTime>2023-08-31T09:14:38Z</CreateTime>
    <KeyAlgorithm>RSA_2048</KeyAlgorithm>
    <KeyOrigin>KMS_PROVIDED</KeyOrigin>
    <PublicKeyData>-----BEGIN CERTIFICATE-----\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----</PublicKeyData>
    <NotAfter>2028-08-31T17:14:33Z</NotAfter>
    <NotBefore>2023-08-31T17:14:33Z</NotBefore>
    <AapName>aap_test</AapName>
</GetClientKeyResponse>

JSON格式

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

{
  "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"
}

错误码

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