Vinculação de um nome de domínio
Cenário
Antes de abrir uma API, você deve vincular um ou mais nomes de domínio independentes ao grupo ao qual a API pertence. Se nenhum nome de domínio estiver vinculado ao grupo, a API será chamada usando o nome de subdomínio padrão do grupo e poderá ser chamada apenas 1000 vezes por dia.
- Em um gateway dedicado ou no gateway compartilhado, você não pode vincular o mesmo nome de domínio independente a diferentes grupos de API.
Observe os seguintes pontos antes de vincular um nome de domínio:
- Nome do subdomínio: depois que um grupo de APIs é criado, o sistema aloca automaticamente um nome de subdomínio exclusivo a ele para testes internos. O nome do subdomínio pode ser acessado 1000 vezes por dia, mas não pode ser modificado.
- Nome de domínio independente: um nome de domínio independente é um nome de domínio personalizado usado para chamadores de API para chamar APIs abertas no grupo ao qual o nome de domínio está vinculado.
Pré-requisitos
- Existe um nome de domínio independente disponível.
- Gateway compartilhado: um registro CNAME aponta o nome de domínio independente para o nome do subdomínio do grupo de API. Para obter detalhes, consulte Adição de um conjunto de registros CNAME.
Gateway dedicado: um registro A aponta o nome de domínio independente para o endereço do gateway. Para obter detalhes, consulte Adição de um conjunto de registros A.
- Se o grupo de APIs contiver APIs que são chamadas por meio de HTTPS, é necessário que haja certificados SSL configurados para o nome de domínio independente. Certificados SSL só podem ser adicionados manualmente com um nome personalizado, conteúdo e uma chave.
Procedimento
- Acesse o console de gerenciamento.
- Clique em no canto superior esquerdo e selecione uma região.
- Clique em no canto superior esquerdo e escolha API Gateway.
- Escolha um tipo de gateway no painel de navegação.
- Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
- Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.
- No painel de navegação, escolha API Publishing > API Groups.
- Vá para a página de guia Domain Names usando um dos seguintes métodos:
- Clique no nome do grupo de API de destino e clique na guia Domain Names na página de detalhes do grupo de API exibida.
- Na coluna Operation do grupo de API de destino, escolha More > Manage Domain Name.
- Clique em Bind Independent Domain Name e insira um nome de domínio.
Para grupos de API criados em gateways dedicados, especifique a versão mínima do TLS (TLS 1.1 ou TLS 1.2) compatível com os nomes de domínio vinculados aos grupos de API. O TLS 1.2 é recomendado.
- Clique em OK.
Se o nome de domínio não for necessário, clique em Unbind para desvinculá-lo do grupo de API.
- (Opcional) Se o grupo de APIs contiver APIs acessadas por HTTPS, adicione um certificado SSL.
- Clique em Add SSL Certificate.
- Digite o nome, o conteúdo e a chave do certificado SSL obtido e clique em OK.
Figura 1 Adição de um certificado SSL
- Atualmente, você só pode adicionar certificados SSL no formato PEM. Para adicionar certificados SSL de outros formatos, converta os certificados para o formato PEM primeiro.
- Para substituir ou editar um certificado SSL, clique em ao lado do nome do certificado. O conteúdo e a chave do certificado não estarão visíveis depois que você clicar em OK para adicionar o certificado. Se o conteúdo tiver sido atualizado, adicione todo o conteúdo ou a chave novamente.
- Se você não precisar de um certificado SSL, clique em Delete SSL Certificate na linha que contém o certificado para excluí-lo.
Vinculação de um nome de domínio chamando uma API
Você também pode vincular um nome de domínio independente a um grupo de APIs chamando uma API fornecida pelo APIG. Para detalhes, consulte as seguintes referências:
Solução de problemas
- Falha na vinculação de um nome de domínio independente: o nome de domínio independente não é CNAMEd para o nome de subdomínio do grupo de API ou o nome de domínio independente já existe.
- Falha ao adicionar um certificado SSL: o nome de domínio do certificado SSL é diferente do nome de domínio para o qual você adiciona o certificado SSL.
Operações de acompanhamento
Depois de vincular nomes de domínio independentes ao grupo de APIs, crie APIs no grupo para expor seletivamente os recursos de back-end. Para mais detalhes, consulte Criação de uma API.