Todos os produtos
Search
Central de documentação

:GetClientKey

Última atualização: Jul 09, 2026

Consulta as informações de uma chave de cliente.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

GetClientKey

Operação a executar. Defina o valor como GetClientKey.

ClientKeyId

String

Sim

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

ID da chave de cliente.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

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

ID da solicitação, usado para localizar e solucionar problemas.

ClientKeyId

String

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

ID da chave de cliente.

CreateTime

String

2023-08-31T09:14:38Z

Data e hora de criação da chave de cliente.

KeyAlgorithm

String

RSA_2048

Algoritmo de chave privada da chave de cliente.

KeyOrigin

String

KMS_PROVIDED

Provedor da chave de cliente.

Atualmente, apenas o Key Management Service (KMS) é compatível. O valor fixo é KMS_PROVIDED.

PublicKeyData

String

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

Conteúdo da chave pública da chave de cliente.

NotAfter

String

2028-08-31T17:14:33Z

Término do período de validade da chave de cliente.

NotBefore

String

2023-08-31T17:14:33Z

Início do período de validade da chave de cliente.

AapName

String

aap_test

Nome do ponto de acesso ao aplicativo (AAP).

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=GetClientKey
&ClientKeyId=KAAP.66abf237-63f6-4625-b8cf-47e1086e****
&Common request parameters

Respostas de sucesso de exemplo

Formato 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>

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.