Todos os produtos
Search

Este produto

    Edge Security Acceleration:GetCustomHostname

    Central de documentação

    Edge Security Acceleration:GetCustomHostname

    Última atualização: Jun 24, 2026

    Obtém a configuração detalhada de um único nome de domínio SaaS, incluindo o nome TXT de verificação de domínio, o conteúdo TXT de verificação de domínio e o tempo de expiração do certificado (quando o SSL está ativado).

    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

    esa:GetCustomHostname

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    HostnameId

    integer

    Sim

    O ID do nome de domínio SaaS. Você pode obter esse valor chamando a operação ListCustomHostnames.

    1234567890123

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação, que é um identificador exclusivo gerado pelo Alibaba Cloud para esta solicitação.

    7C414690-9D7B-5D66-9CD9-AD0B3F25ED49
    CustomHostnameModel

    object

    As informações sobre o nome de domínio SaaS consultado.

    HostnameId

    integer

    O ID do nome de domínio SaaS.

    1234567890123
    Hostname

    string

    O nome de domínio SaaS.

    custom.site.com
    SiteId

    integer

    O ID do site.

    890601022130656
    SiteName

    string

    O nome do site.

    example.com
    RecordId

    integer

    O ID do registro.

    4042843419650112
    RecordName

    string

    O nome do registro.

    origin.example.com
    Status

    string

    O status do nome de domínio SaaS. Valores válidos:

    • pending: Verificação pendente.

    • active: Ativado.

    • conflicted: Ocupado.

    • offline: Offline.

    • configuring: Sendo configurado.

    Valores válidos:

    • conflicted :

      Ocupado.

    • offline :

      Offline.

    • configuring :

      Sendo configurado.

    • pending :

      Verificação pendente.

    • active :

      Ativado.

    active
    VerifyHost

    string

    O nome TXT para verificação de domínio.

    _esa_custom_hostname.custom.site.com
    VerifyCode

    string

    O conteúdo TXT para verificação de domínio.

    verify_16ab7f4d389d4dff6655f995c6a997bd
    SslFlag

    string

    O switch SSL. Valores válidos:

    • on: O SSL está ativado.

    • off: O SSL está desativado.

    Valores válidos:

    • off :

      O SSL está desativado.

    • on :

      O SSL está ativado.

    on
    CertType

    string

    O tipo de certificado. Valores válidos:

    • free: Certificado gratuito.

    • upload: Certificado carregado.

    • cas: Certificado do SSL Certificates Service.

    Valores válidos:

    • cas :

      Certificado do SSL Certificates Service.

    • upload :

      Certificado carregado.

    • free :

      Certificado gratuito.

    free
    CasId

    integer

    O ID do certificado do SSL Certificates Service.

    30000478
    CertId

    string

    O ID do certificado.

    baba2c9e90e840b3b55698cedf02b308
    Certificate

    string

    O conteúdo do certificado.

    -----BEGIN CERTIFICATE-----
    CertStatus

    string

    O status do certificado. Valores válidos:

    • OK: Normal.

    • Applying: Sendo solicitado.

    • ApplyFailed: Falha na solicitação.

    • Expiring: Prestes a expirar.

    • Expired: Expirado.

    Valores válidos:

    • Expiring :

      Prestes a expirar.

    • ApplyFailed :

      Falha na solicitação.

    • Expired :

      Expirado.

    • Applying :

      Sendo solicitado.

    • OK :

      Normal.

    OK
    CertTxtKey

    string

    O nome TXT para verificação de certificado.

    _acme-challenge.custom.site.com
    CertTxtValue

    string

    O conteúdo TXT para verificação de certificado.

    lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM
    CertHttpKey

    string

    O endereço HTTP para verificação de certificado.

    http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc
    CertHttpValue

    string

    O conteúdo HTTP para verificação de certificado.

    jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0
    CertNotAfter

    string

    A hora de expiração do certificado, no formato ISO 8601 com horário UTC. O formato é yyyy-MM-ddTHH:mm:ssZ.

    2026-04-19T11:15:20Z
    CertApplyMessage

    string

    A mensagem de erro da solicitação de certificado gratuito.

    canceled
    CertApplyCode

    integer

    O código de erro da solicitação de certificado gratuito.

    2
    CreateTime

    string

    A hora em que o nome de domínio SaaS foi criado, no formato ISO 8601 com horário UTC. O formato é yyyy-MM-ddTHH:mm:ssZ.

    2026-04-19T11:15:20Z
    UpdateTime

    string

    A hora em que o nome de domínio SaaS foi atualizado pela última vez, no formato ISO 8601 com horário UTC. O formato é yyyy-MM-ddTHH:mm:ssZ.

    2026-04-19T11:15:20Z
    OfflineReason

    string

    O motivo pelo qual o nome de domínio SaaS foi colocado offline. Valores válidos:

    • expiration_arrears: O plano de assinatura expirou ou a conta possui um pagamento em atraso.

    • internally_disabled: Desativado pelo sistema.

    • missing_icp: O nome de domínio não possui um registro ICP.

    • content_violation: Violação de conteúdo.

    • proactively_disabled: Você desativou proativamente o nome de domínio ou o limite de uso configurado foi atingido.

    Valores válidos:

    • expiration_arrears :

      O plano de assinatura expirou ou a conta possui um pagamento em atraso.

    • proactively_disabled :

      Desativado proativamente ou limite de uso atingido.

    • content_violation :

      Violação de conteúdo.

    • internally_disabled :

      Desativado pelo sistema.

    • missing_icp :

      O nome de domínio não possui um registro ICP.

    missing_icp
    ConflictWith

    string

    O motivo pelo qual o nome de domínio SaaS está ocupado. Valores válidos:

    • existing_custom_hostname: Entra em conflito com um nome de domínio SaaS existente.

    • existing_record: Entra em conflito com um registro de site existente.

    • existing_load_balancer: Entra em conflito com uma instância de load balancer existente.

    • existing_origin_pool: Entra em conflito com um pool IPAM de origem existente.

    • existing_site: Entra em conflito com um site existente.

    Valores válidos:

    • existing_load_balancer :

      Entra em conflito com uma instância de load balancer existente.

    • existing_custom_hostname :

      Entra em conflito com um nome de domínio SaaS existente.

    • existing_site :

      Entra em conflito com um site existente.

    • existing_record :

      Entra em conflito com um registro de site existente.

    • existing_origin_pool :

      Entra em conflito com um pool de origem existente.

    existing_custom_hostname
    PrivateKey

    string

    A chave privada do certificado.

    -----BEGIN RSA PRIVATE KEY-----

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "7C414690-9D7B-5D66-9CD9-AD0B3F25ED49",
  "CustomHostnameModel": {
    "HostnameId": 1234567890123,
    "Hostname": "custom.site.com",
    "SiteId": 890601022130656,
    "SiteName": "example.com",
    "RecordId": 4042843419650112,
    "RecordName": "origin.example.com",
    "Status": "active",
    "VerifyHost": "_esa_custom_hostname.custom.site.com",
    "VerifyCode": "verify_16ab7f4d389d4dff6655f995c6a997bd",
    "SslFlag": "on",
    "CertType": "free",
    "CasId": 30000478,
    "CertId": "baba2c9e90e840b3b55698cedf02b308",
    "Certificate": "-----BEGIN CERTIFICATE-----",
    "CertStatus": "OK",
    "CertTxtKey": "_acme-challenge.custom.site.com",
    "CertTxtValue": "lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM",
    "CertHttpKey": "http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc",
    "CertHttpValue": "jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0",
    "CertNotAfter": "2026-04-19T11:15:20Z",
    "CertApplyMessage": "canceled",
    "CertApplyCode": 2,
    "CreateTime": "2026-04-19T11:15:20Z",
    "UpdateTime": "2026-04-19T11:15:20Z",
    "OfflineReason": "missing_icp",
    "ConflictWith": "existing_custom_hostname",
    "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----"
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InternalException Failed to call the service. Try again later or contact technical support. Failed to call the service. Try again later or contact technical support.
    400 InvalidParameter The specified parameter is invalid. The specified parameter is invalid.
    404 CustomHostname.NotFound The custom hostname does not exist. Modify it and try again. The custom hostname does not exist. Modify it and try again.
    404 CustomHostname.ApplyCertFailed Fail to apply a free cert for custom hostname. Please try again later.
    404 CustomHostname.SetCertFailed Fail to deploy a cert for custom hostname. Please try again later.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.