Todos os produtos
Search

Este produto

    API Gateway:Chamar APIs por meio de um nome de domínio HTTPS

    Central de documentação

    API Gateway:Chamar APIs por meio de um nome de domínio HTTPS

    Última atualização: Sep 21, 2026

    Vincule seu nome de domínio HTTPS a um grupo de API no API Gateway e faça upload de um certificado SSL para o domínio. Em seguida, chame as APIs do grupo por meio do nome de domínio HTTPS.

    Notas de uso

    Os nomes de domínio independentes a serem vinculados a grupos de API devem atender aos seguintes requisitos:

    • Para vincular um nome de domínio independente a um grupo de API em uma região dentro da China continental, solicite um número ICP no Alibaba Cloud ICP Filing system para o domínio, ou adicione a Alibaba Cloud como provedor de serviço às informações de registro ICP (Internet content provider) do domínio.

    • Antes de vincular um nome de domínio independente a um grupo de API, adicione um registro CNAME para mapear o nome de domínio independente ao nome de domínio de segundo nível do grupo de API.

    • O nome de domínio independente a ser vinculado não pode ter sido vinculado a um grupo de API hospedado no API Gateway por outros usuários. Caso já tenha sido vinculado por outros usuários, a titularidade precisará ser verificada no momento da vinculação. Para chamar as APIs do grupo de API via HTTPS, importe ou faça upload de um certificado SSL para o nome de domínio independente.

    Importante

    Por padrão, o API Gateway fornece um nome de domínio público de segundo nível para cada grupo de API. Quando um cliente usa esse nome de domínio para iniciar chamadas de API, o número diário de chamadas é limitado. O limite é de 100 chamadas de API na região China (Hong Kong) e nas regiões fora da China continental, e de 1.000 chamadas de API nas regiões dentro da China continental. Para publicar APIs em um ambiente de produção, vincule um nome de domínio independente ao grupo de API ao qual as APIs pertencem. Nomes de domínio independentes não têm limite de chamadas de API.

    Procedimento

    Conclua as etapas a seguir para vincular um nome de domínio HTTPS a um grupo de API e fazer upload de um certificado SSL.

    1. Resolução de nome de domínio: adicione um registro CNAME ou TXT para mapear seu nome de domínio independente público ou interno ao nome de domínio público ou interno de segundo nível fornecido pelo grupo de API. Para mais informações, consulte Domain name resolution.

      • Resolução de nome de domínio público: use o Alibaba Cloud DNS (DNS) para mapear seu nome de domínio público ao nome de domínio público de segundo nível fornecido pelo API Gateway para o grupo de API. Para mais informações, consulte Public domain name resolution.

      • Resolução de nome de domínio interno: use o Alibaba Cloud DNS para mapear seu nome de domínio interno ao nome de domínio interno de segundo nível fornecido pelo API Gateway para o grupo de API. Para mais informações, consulte Internal domain name resolution.

    2. Vinculação do nome de domínio: na página Group Details do console do API Gateway, vincule seu nome de domínio independente ao grupo de API. Para mais informações, consulte Domain name binding.

    3. Upload do certificado SSL: configure um certificado SSL para o domínio a fim de chamar APIs via HTTPS usando esse domínio. Para mais informações, consulte Upload an SSL certificate.

    Resolução de nome de domínio

    Resolução de nome de domínio público

    1. Faça login no API Gateway console. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.

    2. Na página API Groups, clique no grupo de API desejado. Na seção Basic Information, localize o nome de domínio público de segundo nível.

    3. Faça login no DNS console. Escolha Public DNS > Authoritative DNS Resolution. Clique na aba Authoritative Domain Names e, em seguida, clique no nome de domínio para abrir a aba DNS Settings.

    4. Na aba DNS Settings, clique em Add DNS Record. Defina Record Type como CNAME, Hostname como o prefixo do nome de domínio e Record Value como o nome de domínio público de segundo nível. Clique em OK.

    Resolução de nome de domínio interno

    1. Faça login no API Gateway console. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.

    2. Na página API Groups, clique no grupo de API desejado. Na seção Basic Information, localize o nome de domínio VPC interno.

    3. Faça login no DNS console. Clique em Private DNS (PrivateZone). No canto superior direito da página Private DNS (PrivateZone), clique em Configuration Mode. Na aba User Defined Zones, clique em Add New Zone.

    4. No painel Add Built-in Authoritative Zone, especifique Built-in Authoritative Zone e Alibaba Cloud VPC, e clique em OK.

      Para Domain Type, selecione Built-in Authoritative Acceleration Zone. Essa opção é recomendada para obter a menor latência de resolução.

      Nota

      Em Built-in Authoritative Zone, insira o nome de domínio personalizado (interno) vinculado ao grupo de API. Esse nome de domínio é usado exclusivamente para private DNS (PrivateZone) em VPCs.

    5. Clique no nome da zona para abrir a aba Resource Records Settings. Clique em Add Record. No painel Add Record, defina Record Type como CNAME, Hostname como o prefixo do nome de domínio e Record Value como o nome de domínio VPC interno. Clique em OK.

    Nota

    • Na instância do Elastic Compute Service (ECS) implantada no VPC associado à zona privada, o registro da zona privada substitui o registro DNS público.

    • Em VPCs, o registro DNS público da zona privada não é afetado. Adicione registros DNS às suas zonas privadas para evitar que zonas sem registros sobrescrevam o registro DNS público — caso contrário, ocorrerão erros de resolução DNS. Para mais informações, consulte Activate Alibaba Cloud DNS PrivateZone.

    Vinculação de nome de domínio

    1. Faça login no API Gateway console. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.

    2. Na página API Groups, clique no grupo de API a ser vinculado ao domínio para acessar a página Group Details. Na seção Independent Domains, clique em Bind Domain Name.

    3. Na caixa de diálogo Bind Domain Name, configure os parâmetros a seguir e clique em Confirm.

      Parâmetro

      Descrição

      Domain Name

      Insira o nome de domínio a ser vinculado ao grupo de API.

      Environment

      O ambiente associado ao nome de domínio. Valores válidos:

      • Test: permite chamar apenas as APIs do ambiente de teste.

      • Pre: permite chamar apenas as APIs do ambiente de staging.

      • Production: permite chamar apenas as APIs do ambiente de produção.

      • Default (X-Ca-Stage): permite chamar as APIs de todos os ambientes mencionados. Ao chamar uma API, adicione o parâmetro X-Ca-Stage ao cabeçalho da requisição para especificar o ambiente desejado.

      Network Type

      Internet: permite chamar APIs somente pela Internet. Internal Network: permite chamar APIs somente por redes internas.
    Nota

    • A verificação de titularidade não é necessária para nomes de domínio internos. Se o domínio conflitar com outro já vinculado a um grupo de API pertencente à mesma instância que o grupo atual, a vinculação falhará.

    • Após vincular o nome de domínio ao grupo de API, não é possível alterar o tipo de rede do domínio. Se a configuração estiver incorreta, exclua o domínio e vincule-o novamente ao grupo de API.

    Perguntas frequentes sobre vinculação de nome de domínio

    Por que a vinculação do nome de domínio falha?

    • O nome de domínio já está vinculado a outro grupo de API na mesma instância, ou um domínio curinga conflita com um domínio único. Desvincule primeiro o domínio conflitante.

    • O domínio está vinculado a um grupo de API pertencente a outro usuário, ou existe um conflito com um domínio curinga. Conclua Domain name ownership verification antes de prosseguir com a vinculação.

    Fazer upload de um certificado SSL

    Após vincular um nome de domínio a um grupo de API, as APIs podem ser chamadas via HTTP por padrão. Para chamá-las via HTTPS, faça upload de um certificado SSL para o domínio. O API Gateway oferece dois métodos: importação automática pelo Alibaba Cloud Certificate Management Service ou upload manual de um certificado de outro provedor.

    Gerar um certificado SSL

    Para gerar um certificado SSL gratuito pelo Alibaba Cloud Certificate Management Service:

    1. Faça login no Alibaba Cloud SSL Certificates console.

    2. Na página de compra de certificados, adquira o certificado e vincule-o ao nome de domínio. Para mais informações, consulte Get started with SSL Certificates Service. Após solicitar o certificado SSL, acesse a página Group Details do grupo de API no console do API Gateway.

    Importar ou fazer upload de um certificado SSL

    Após obter um certificado SSL, importe-o ou faça upload dele para o nome de domínio vinculado ao grupo de API.

    Importar um certificado SSL

    Caso tenha adquirido o certificado pelo Alibaba Cloud Certificate Management Service, importe-o para o nome de domínio vinculado:

    1. Faça login no API Gateway console. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.

    2. Na página API Groups, clique no grupo de API desejado para acessar a página Group Details. Na seção Independent Domains, visualize os nomes de domínio vinculados ao grupo de API. Localize o domínio para o qual deseja importar o certificado SSL e clique em Select Certificate na coluna SSL Certificate.

    3. Na caixa de diálogo Select Certificate, clique em Search for Certificate. Em seguida, selecione o certificado desejado nos resultados da pesquisa e clique em Synchronize Certificate.

    Fazer upload de um certificado SSL

    Se o certificado SSL for de um provedor terceiro, faça upload dele no API Gateway:

    1. Faça login no API Gateway console. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.

    2. Na página API Groups, clique no grupo de API desejado para acessar a página Group Details. Na seção Independent Domains, visualize os nomes de domínio vinculados ao grupo de API. Localize o domínio para o qual deseja importar o certificado SSL e clique em Select Certificate na coluna SSL Certificate.

    3. Na caixa de diálogo Select Certificate, clique em Add Certificate.

    4. Na caixa de diálogo Create Certificate, insira e faça upload do conteúdo do certificado conforme solicitado e clique em Confirm.

    5. Após o upload do certificado, acesse a página Group Details. O hiperlink Select Certificate do domínio na seção Independent Domains será alterado para Update Certificate. A partir desse momento, o domínio poderá ser usado para chamar APIs via HTTPS.