Todos os produtos
Search

Este produto

    :DescribeCertificateState

    Central de documentação

    :DescribeCertificateState

    Última atualização: Jun 28, 2026

    Consulta o status de um pedido de certificado, como o progresso de validação do domínio.

    Descrição da operação

    Se você não concluiu a validação de propriedade do domínio após enviar uma solicitação de certificado, pode chamar esta operação para obter as informações necessárias para concluir a validação do domínio. Usando as informações de validação de domínio retornadas, você pode concluir a validação do domínio na plataforma de gerenciamento de DNS (método de validação de DNS) ou no servidor de domínio (método de validação de arquivo).

    Sua solicitação de certificado entrará na etapa de revisão do centro de CA somente após você concluir a validação do domínio. Depois que o centro de CA aprovar sua solicitação de certificado, um certificado será emitido para você. Se o certificado já tiver sido emitido, você pode chamar esta operação para obter o arquivo do certificado emitido e o conteúdo da chave privada.

    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:DescribeCertificateState

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    OrderId

    integer

    Sim

    O ID do pedido de solicitação de certificado a ser consultado.

    Nota

    Você pode chamar ListUserCertificateOrder para obter esse ID.

    123451222

    Ao chamar uma operação de API, além dos parâmetros de solicitação específicos da operação, você também deve incluir os parâmetros de solicitação comuns do Alibaba Cloud.

    Para obter o formato de solicitação ao chamar uma operação de API, consulte os exemplos de solicitação na seção Exemplos deste tópico.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O objeto.

    Type

    string

    O status do pedido de solicitação de certificado. Valores válidos:

    • domain_verify: Validação pendente, que indica que você não concluiu a validação do domínio após enviar a solicitação de certificado.

      Nota

      Após enviar uma solicitação de certificado, você deve concluir manualmente a validação de propriedade do domínio antes que a solicitação de certificado possa entrar na etapa de revisão. Se você não concluiu a validação do domínio, pode consultar os parâmetros de resposta desta operação para concluir a validação do domínio.

    • process: Em revisão, que indica que a solicitação de certificado está sendo revisada pelo centro de CA.

    • verify_fail: Falha na revisão, que indica que a solicitação de certificado falhou na revisão.

      Nota

      A revisão pode falhar porque as informações da solicitação de certificado que você enviou estão incorretas. Recomendamos que você chame DeleteCertificateRequest para excluir o pedido que falhou na revisão (pedidos excluídos não consomem a cota do plano de recursos de certificado) e envie uma nova solicitação de certificado.

    • certificate: Emitido, que indica que o certificado foi emitido.

    • payed: Solicitação pendente, que indica que o certificado está com a solicitação pendente.

    • unknow: Status desconhecido.

    domain_verify
    Domain

    string

    O nome de domínio a ser validado quando você usa o método de validação de arquivo para a validação de domínio. Você precisa se conectar ao servidor correspondente a este nome de domínio e criar o arquivo especificado (ou seja, Uri) no servidor.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como FILE (indicando o método de validação de arquivo).

    www.example.com
    RecordType

    string

    O tipo de registro DNS que você precisa adicionar quando usa o método de validação de DNS para a validação de domínio. Valores válidos:

    • TXT: registro de texto.

    • CNAME: registro de alias.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como DNS (indicando o método de validação de DNS).

    TXT
    CertId

    string

    O ID do certificado.

    Nota

    Este parâmetro é retornado quando o certificado é emitido.

    111111
    RequestId

    string

    O ID da solicitação.

    082FAB35-6AB9-4FD5-8750-D36673548E76
    RecordDomain

    string

    O registro de host que você precisa operar quando usa o método de validação de DNS para a validação de domínio.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como DNS (indicando o método de validação de DNS).

    _dnsauth
    PrivateKey

    string

    O conteúdo da chave privada do certificado (no formato PEM). Para obter mais informações sobre o formato PEM e como converter o formato de um certificado, consulte Quais são os formatos dos principais certificados digitais?.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como certificate (indicando que o certificado foi emitido).

    -----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----
    ValidateType

    string

    O método de validação de domínio selecionado ao enviar a solicitação de certificado. Valores válidos:

    • DNS: validação de DNS. Este método valida a propriedade do domínio adicionando o registro DNS especificado ao domínio na plataforma de gerenciamento de DNS.

    • FILE: validação de arquivo. Este método valida a propriedade do domínio criando o arquivo especificado no servidor de domínio.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio).

    FILE
    RecordValue

    string

    O valor do registro que você precisa adicionar quando usa o método de validação de DNS para a validação de domínio.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como DNS (indicando o método de validação de DNS).

    20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy
    Content

    string

    O conteúdo que você precisa gravar no arquivo recém-criado quando usa o método de validação de arquivo para a validação de domínio.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como FILE (indicando o método de validação de arquivo).

    http://example.com/.well-known/pki-validation/fileauth.txt
    Uri

    string

    O arquivo que você precisa criar no servidor de domínio quando usa o método de validação de arquivo para a validação de domínio. Uri inclui o caminho e o nome do arquivo.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como domain_verify (indicando a etapa de validação de domínio) e ValidateType está definido como FILE (indicando o método de validação de arquivo).

    /.well-known/pki-validation/fileauth.txt
    Certificate

    string

    O conteúdo do certificado (no formato PEM). Para obter mais informações sobre o formato PEM e como converter o formato de um certificado, consulte Quais são os formatos dos principais certificados digitais?.

    Nota

    Este parâmetro é retornado apenas quando Type está definido como certificate (indicando que o certificado foi emitido).

    -----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Type": "domain_verify",
  "Domain": "www.example.com",
  "RecordType": "TXT",
  "CertId": "111111",
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "RecordDomain": "_dnsauth",
  "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----",
  "ValidateType": "FILE",
  "RecordValue": "20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy",
  "Content": "http://example.com/.well-known/pki-validation/fileauth.txt",
  "Uri": "/.well-known/pki-validation/fileauth.txt",
  "Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----"
}

    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.