Vincule seu nome de domínio HTTPS a um grupo de APIs no API Gateway e faça upload de um certificado SSL para o domínio. Em seguida, chame as APIs do grupo usando o nome de domínio HTTPS.
Observações de uso
Os nomes de domínio independentes vinculados a grupos de APIs devem atender aos seguintes requisitos:
Para vincular um nome de domínio independente a um grupo de APIs em uma região da China continental, solicite um número ICP no sistema de Arquivamento ICP da Alibaba Cloud referente ao domínio ou adicione a Alibaba Cloud como provedor de serviços nas informações de arquivamento ICP do domínio.
Antes de vincular um nome de domínio independente a um grupo de APIs, adicione um registro CNAME para mapear o domínio independente ao nome de domínio de segundo nível do grupo de APIs.
O nome de domínio independente não pode estar vinculado a um grupo de APIs hospedado no API Gateway por outros usuários. Caso já esteja vinculado, será necessária verificação durante a tentativa de vínculo. Para chamar as APIs do grupo via HTTPS, importe ou faça upload de um certificado SSL para o domínio independente.
Por padrão, o API Gateway fornece um nome de domínio público de segundo nível para cada grupo de APIs. Quando um cliente utiliza esse domínio público para iniciar chamadas de API, a quantidade diária de chamadas é limitada. O limite é de 100 chamadas na região China (Hong Kong) e em regiões fora da China continental, e de 1.000 chamadas nas regiões dentro da China continental. Para publicar APIs em ambiente de produção, vincule um nome de domínio independente ao grupo de APIs correspondente. Não há limite de chamadas de API para nomes de domínio independentes.
Procedimento
Siga as etapas abaixo para vincular um nome de domínio HTTPS a um grupo de APIs e fazer upload de um certificado SSL.
-
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 de segundo nível público ou interno fornecido pelo grupo de APIs. Para mais informações, consulte Resolução de nome de domínio.
Resolução de nome de domínio público: utilize o Alibaba Cloud DNS (DNS) para mapear seu domínio público ao nome de domínio público de segundo nível fornecido pelo API Gateway para o grupo de APIs. Para mais informações, consulte Resolução de nome de domínio público.
Resolução de nome de domínio interno: use o Alibaba Cloud DNS para mapear seu domínio interno ao nome de domínio interno de segundo nível fornecido pelo API Gateway para o grupo de APIs. Para mais informações, consulte Resolução de nome de domínio interno.
Vínculo de nome de domínio: na página Group Details do console do API Gateway, vincule seu nome de domínio independente ao grupo de APIs. Para mais informações, consulte Vínculo de nome de domínio.
Upload de certificado SSL: configure um certificado SSL para o domínio para permitir chamadas de API via HTTPS. Para mais informações, consulte Fazer upload de um certificado SSL.
Resolução de nome de domínio
Resolução de nome de domínio público
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.
Na página API Groups, clique em no grupo de APIs desejado. Na seção Basic Information, localize o nome de domínio público de segundo nível.
Acesse o console de DNS. Escolha Public DNS > Authoritative DNS Resolution. Clique em na aba Authoritative Domain Names e, em seguida, clique em no nome de domínio para abrir a aba DNS Settings.
Na aba DNS Settings, clique em Add DNS Record. Defina Record Type como CNAME, Hostname como o prefixo do 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
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.
Na página API Groups, clique em no grupo de APIs desejado. Na seção Basic Information, localize o nome de domínio VPC interno.
Acesse o console de DNS. 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.
-
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. Esta opção é recomendada para obter a menor latência de resolução.
NotaEm Built-in Authoritative Zone, insira o nome de domínio personalizado (interno) vinculado ao grupo de APIs. Este domínio é utilizado exclusivamente para private DNS (PrivateZone) em VPCs.
Clique em 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 domínio e Record Value como o nome de domínio VPC interno. Clique em OK.
Na instância do Elastic Compute Service (ECS) implantada na VPC associada à zona privada, o registro da zona privada substitui o registro de DNS público.
Nas VPCs, o registro de DNS público da zona privada não é afetado. Adicione registros de DNS para suas zonas privadas a fim de evitar que zonas privadas sem registros de DNS sobrescrevam o registro de DNS público. Caso contrário, ocorrerão erros de resolução de DNS. Para mais informações, consulte Ativar Alibaba Cloud DNS PrivateZone.
Vínculo de nome de domínio
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.
Na página API Groups, clique em no grupo de APIs a ser vinculado ao domínio para acessar a página Group Details. Na seção Independent Domains, clique em Bind Domain Name.
-
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 APIs.
Environment
Ambiente associado ao nome de domínio. Valores válidos:
-
Test: permite chamar apenas as APIs do ambiente de teste.
-
Pre: restringe as chamadas às APIs do ambiente de staging.
-
Production: habilita chamadas somente para as APIs do ambiente de produção.
-
Default (X-Ca-Stage): possibilita chamar todas as APIs dos ambientes listados acima. Ao chamar a API, adicione o parâmetro X-Ca-Stage ao cabeçalho da requisição para especificar o ambiente desejado.
Network Type
Internet: as APIs são acessíveis apenas pela Internet. Internal Network: o acesso às APIs ocorre exclusivamente por redes internas.
-
Não é necessário verificar a propriedade de um nome de domínio interno. Se houver conflito com um domínio já vinculado a outro grupo de APIs na mesma instância, o vínculo do domínio atual falhará.
Após vincular o domínio ao grupo de APIs, 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 APIs.
Perguntas frequentes sobre vínculo de nome de domínio
Por que o vínculo do nome de domínio falha?
O domínio já está vinculado a outro grupo de APIs na mesma instância ou existe conflito entre um domínio curinga e um domínio único. Desvincule primeiro o domínio conflitante.
O domínio pertence a um grupo de APIs de outro usuário ou há conflito de domínio curinga. Conclua a Verificação de propriedade do nome de domínio antes de vincular.
Fazer upload de um certificado SSL
Após vincular um nome de domínio a um grupo de APIs, as chamadas via HTTP ficam disponíveis por padrão. Para utilizar HTTPS, faça upload de um certificado SSL para o domínio. O API Gateway oferece dois métodos: importação automática do Alibaba Cloud Certificate Management Service e upload manual de certificados de outros provedores.
Gerar um certificado SSL
Para gerar um certificado SSL gratuito por meio do Alibaba Cloud Certificate Management Service:
Na página de compra de certificados, adquira o certificado e vincule-o ao nome de domínio. Para mais informações, consulte Introdução ao SSL Certificates Service. Após solicitar o certificado SSL, acesse a página Group Details do grupo de APIs no console do API Gateway.
Importar ou fazer upload de um certificado SSL
Depois de obter um certificado SSL, importe-o ou faça upload dele para o nome de domínio vinculado ao grupo de APIs.
Importar um certificado SSL
Se você adquiriu um certificado pelo Alibaba Cloud Certificate Management Service, importe-o para o domínio vinculado:
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.
Na página API Groups, clique em no grupo de APIs desejado para acessar a página Group Details. Na seção Independent Domains, visualize os domínios vinculados ao grupo. Localize o domínio para o qual deseja importar o certificado SSL e clique em Select Certificate na coluna SSL Certificate.
Na caixa de diálogo Select Certificate, clique em Search for Certificate. Em seguida, selecione o certificado necessário nos resultados da busca e clique em Synchronize Certificate.
Fazer upload de um certificado SSL
Caso seu certificado SSL seja de um provedor terceirizado, faça upload dele no API Gateway:
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups e selecione uma região.
Na página API Groups, clique em no grupo de APIs desejado para acessar a página Group Details. Na seção Independent Domains, visualize os domínios vinculados ao grupo. Localize o domínio para o qual deseja importar o certificado SSL e clique em Select Certificate na coluna SSL Certificate.
Na caixa de diálogo Select Certificate, clique em Add Certificate.
Na caixa de diálogo Create Certificate, insira e faça upload do conteúdo do certificado conforme solicitado e clique em Confirm.
Após o upload do certificado, retorne à página Group Details. O hiperlink Select Certificate do domínio na seção Independent Domains mudará para Update Certificate. Com o certificado carregado, o domínio estará apto a realizar chamadas de API via HTTPS.