DescribeClientCertificate - Certificate Management Service: Central de Documentação do Alibaba Cloud

Obtém um certificado de cliente ou certificado de servidor pelo seu identificador exclusivo.

Descrição da operação

Você pode chamar esta operação para consultar os detalhes de um certificado de cliente ou de um certificado de servidor pelo seu identificador exclusivo. Os detalhes incluem o número de série, o assunto, o conteúdo e o status do certificado.

Antes de chamar esta operação, você deve criar um certificado de cliente ou um certificado de servidor.

Para criar um certificado de cliente chamando uma API, consulte os seguintes tópicos:

Para criar um certificado de servidor chamando uma API, consulte os seguintes tópicos:

Limites

O limite de consultas por segundo (QPS) para esta chamada de API é de 10 por usuário. Se você exceder esse limite, o throttling será acionado, o que pode afetar seus negócios. Planeje suas chamadas de acordo.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

yundun-cert:DescribeClientCertificate

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Identifier	string	Sim	O identificador exclusivo do certificado de cliente ou certificado de servidor a ser consultado. Nota Chame ListClientCertificate para consultar os identificadores exclusivos de todos os certificados de cliente e certificados de servidor.	d3b95700998e47afc4d95f886579****

Além dos parâmetros de solicitação anteriores, você deve especificar parâmetros de solicitação comuns ao chamar esta API. Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Para o formato da solicitação, consulte o exemplo de solicitação na seção Exemplos deste tópico.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	DescribeCertificateResponse<CertificateWithContentDTO>
Certificate	object	Os detalhes do certificado de cliente ou do certificado de servidor.
X509Certificate	string	O conteúdo do certificado.	-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifier	string	O identificador exclusivo do certificado.	d3b95700998e47afc4d95f886579****
SerialNumber	string	O número de série do certificado.	62b2b943a32d96883a6650e672ea0276****
SubjectDN	string	O Nome Distinto (DN) do assunto do certificado. Este valor é composto pelos seguintes campos: C: País. O: Organização. OU: Unidade organizacional. CN: Nome comum. ST: Província ou estado. CN: Nome comum.	C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName	string	O nome comum do certificado.	aliyun.com
OrganizationUnit	string	A unidade organizacional do assunto do certificado.	Security
Organization	string	A organização associada ao certificado da AC subordinada emissora.	Aliyun
Locality	string	A cidade onde a organização do assunto está localizada.	Hangzhou
State	string	O estado ou província onde a organização do assunto está localizada.	Zhejiang
CountryCode	string	O código do país da organização do assunto. Para obter mais informações sobre códigos de país, consulte a seção Códigos internacionais em Gerenciar perfis de empresa.	CN
Sans	string	A extensão Nome Alternativo do Assunto (SAN) do certificado. A extensão SAN indica outros nomes de domínio ou endereços IP associados ao certificado. Este parâmetro é uma string convertida de uma matriz JSON. Cada elemento na matriz JSON é uma estrutura que corresponde a uma extensão SAN. Cada estrutura de extensão SAN contém os seguintes parâmetros: Type: O tipo da extensão. Este parâmetro é do tipo Integer. Valores válidos: 1: um endereço de e-mail. 2: um nome de domínio. 6: um Identificador Uniforme de Recursos (URI). 7: um endereço IP. Value: O conteúdo da extensão. Este parâmetro é do tipo String.	[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]
Status	string	O status do certificado. Valores válidos: ISSUE: O certificado foi emitido. REVOKE: O certificado foi revogado.	ISSUE
BeforeDate	integer	A data de emissão do certificado. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1634283958000
AfterDate	integer	A data de validade do certificado. Este valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1665819958000
Algorithm	string	O tipo do algoritmo de criptografia. Valores válidos: RSA: o algoritmo RSA. ECC: o algoritmo ECC. SM2: o algoritmo SM2.	RSA
KeySize	integer	O comprimento da chave do certificado.	4096
SignAlgorithm	string	O algoritmo de assinatura do certificado.	SHA256WITHRSA
CertificateType	string	O tipo do certificado. Valores válidos: CLIENT: um certificado de cliente. SERVER: um certificado de servidor.	SERVER
ParentIdentifier	string	O identificador exclusivo do certificado da AC subordinada que emitiu o certificado.	160ae6bb538d538c70c01f81dcf2****
Sha2	string	A impressão digital SHA-256 do certificado.	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5	string	A impressão digital MD5 do certificado.	d3b95700998e47afc4d95f886579****
Days	integer	O período de validade do certificado. Unidade: dias.	365
ResourceGroupId	string	O ID do grupo de recursos ao qual o certificado pertence.	rg-acfmxllajdpw3fi
CertChain	string	A cadeia de certificados completa.	-----BEGIN CERTIFICATE----- cert -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- subCA -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- rootCA -----END CERTIFICATE-----
CustomIdentifier	string	O identificador personalizado, que é uma chave exclusiva.	*3a32d96883a6650e672ea0276**
UploadFlag	integer	Indica se o certificado está sincronizado com o Serviço de Gerenciamento de Certificados Digitais.	1
FullAlgorithm	string	O algoritmo e seu comprimento.	RSA_2048
AliasName	string	O alias do certificado emitido.	rsa_root_2048
Id	integer	O ID da fonte de dados à qual o pedido do certificado pertence.	1137354
Tags	array<object>	A lista de tags.	mtls
	object	O valor da tag.
TagKey	string	The tag key.	testKey
TagValue	string	The tag value.	[{\"tag\":\"PROPERTY_TYPE\",\"values\":[]}]
RequestId	string	O ID da solicitação.	15C66C7B-671A-4297-9187-2C4477247A74

Exemplos

Resposta de sucesso

JSON formato

{
  "Certificate": {
    "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "Identifier": "d3b95700998e47afc4d95f886579****",
    "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
    "SubjectDN": "C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "CommonName": "aliyun.com",
    "OrganizationUnit": "Security",
    "Organization": "Aliyun",
    "Locality": "Hangzhou",
    "State": "Zhejiang",
    "CountryCode": "CN",
    "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "Status": "ISSUE",
    "BeforeDate": 1634283958000,
    "AfterDate": 1665819958000,
    "Algorithm": "RSA",
    "KeySize": 4096,
    "SignAlgorithm": "SHA256WITHRSA",
    "CertificateType": "SERVER",
    "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
    "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "Md5": "d3b95700998e47afc4d95f886579****",
    "Days": 365,
    "ResourceGroupId": "rg-acfmxllajdpw3fi",
    "CertChain": "-----BEGIN CERTIFICATE-----\ncert\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nsubCA\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nrootCA\n-----END CERTIFICATE-----",
    "CustomIdentifier": "***3a32d96883a6650e672ea0276****",
    "UploadFlag": 1,
    "FullAlgorithm": "RSA_2048",
    "AliasName": "rsa_root_2048",
    "Id": 1137354,
    "Tags": [
      {
        "TagKey": "testKey",
        "TagValue": "[{\\\"tag\\\":\\\"PROPERTY_TYPE\\\",\\\"values\\\":[]}]"
      }
    ]
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.