Documentação do Oracle Cloud Infrastructure

Atualizando um Gateway de API

Descubra como modificar gateways de API que você criou anteriormente com o serviço API Gateway.

Depois de criar um gateway de API, você poderá decidir alterar o gateway de API. Por exemplo, talvez você queira alterar o nome do gateway de API ou as tags aplicadas a ele.

Observe que há algumas propriedades de gateways de API cujos valores originais você não pode alterar.

Você pode atualizar gateways de API usando a Console, a CLI e a API.

    1. Na página da lista Gateways, localize o gateway de API que você deseja atualizar. Se precisar de ajuda para localizar a página da lista ou o gateway de API, consulte Listando Gateways de API.
    2. No menu Ações (três pontos) do gateway de API:
      • Selecione Editar para alterar qualquer uma das seguintes propriedades do gateway de API:
        • Altere o nome do gateway de API. Evite digitar informações confidenciais.
        • Ative ou desative o uso de grupos de segurança de rede (NSGs) para controlar o acesso de e para o gateway de API usando regras de segurança definidas para os NSGs especificados (até cinco grupos de segurança de rede no máximo). Você pode usar regras de segurança definidas para NSGs em vez das definidas para listas de segurança ou além delas. Os NSGs podem pertencer ao mesmo compartimento do gateway de API, mas não precisam. Consulte Grupos de Segurança de Rede.
        • Altere o certificado TLS e o nome do domínio usados pelo gateway de API. Observe que os recursos de certificado do serviço API Gateway e os recursos de certificado do serviço Certificates só serão mostrados se estiverem disponíveis no compartimento selecionado. Consulte Configurando Domínios e Certificados TLS Personalizados.
        • Altere as definições de configuração do cache de resposta. Consulte Armazenando Respostas no Cache para Melhorar o Desempenho.
        • Altere as Autoridades de Certificação (CAs) e os pacotes de CAs incluídos no armazenamento confiável do gateway de API como CAs personalizadas e pacotes de CAs personalizados (além do pacote de CAs padrão). Consulte Personalizando Armazenamentos Confiáveis para Verificação de Certificado TLS.
      • Selecione Mover Recurso para mover o gateway de API para outro compartimento.
      • Selecione a guia Tags para exibir e editar as tags aplicadas ao gateway de API e selecione Adicionar tags para aplicar mais tags ao gateway de API.

  • Para atualizar gateways de API existentes usando a CLI:

    1. Configure seu ambiente de cliente para usar a CLI ( Configurando Seu Ambiente de Cliente para usar a CLI para o Desenvolvimento de Gateway de API).

    2. Para atualizar um gateway de API existente:

      1. Abra um prompt de comando e execute oci api-gateway gateway update para atualizar o gateway de API:

        oci api-gateway gateway update --gateway-id <gateway-ocid> --<property-to-update> <property-value>

        em que:

        • <gateway-ocid> é o OCID do gateway de API a ser atualizado. Para descobrir o OCID do gateway de API, consulte Lista de Gateways de API.
        • <property-to-update> é a propriedade a ser atualizada. Observe que você só poderá alterar os valores de display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags e defined-tags (e certificate-id> se isso tiver sido originalmente definido para o gateway de API). Todos os outros valores devem ser idênticos aos valores na definição do gateway original.
        • <property-value> é o novo valor da propriedade que você deseja alterar.

        Por exemplo:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2"

        A resposta ao comando inclui:

        • O estado do ciclo de vida (por exemplo, ACTIVE, FAILED).
        • O id da solicitação de serviço para atualizar o gateway de API (detalhes das solicitações de serviço ficam disponíveis por sete dias após a conclusão, o cancelamento ou a falha).

        Se você quiser que o comando aguarde o retorno de controle até que o gateway de API esteja ativo (ou a solicitação tenha falhado), inclua um ou ambos os parâmetros a seguir:

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        Por exemplo:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2" --wait-for-state ACTIVE

      2. (Opcional) Para ver o status da solicitação de serviço que está atualizando o gateway de API, informe:

        oci api-gateway work-request get --work-request-id <work-request-ocid>

      3. (Opcional) Para exibir os logs da solicitação de serviço que está atualizando o gateway de API, informe:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

      4. (Opcional) Se a solicitação de serviço que estiver atualizando o gateway de API falhar e você quiser revisar os logs de erro, informe:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

      5. (Opcional) Para verificar se o gateway de API foi atualizado, informe o seguinte comando e confirme se as propriedades do gateway de API são as que você espera:

        oci api-gateway gateway get --gateway-id <gateway-ocid>

    Para obter mais informações sobre o uso da CLI, consulte Interface de Linha de Comando (CLI). Para obter uma lista completa de flags e opções disponíveis para comandos da CLI, consulte a Ajuda da CLI.

  • Execute a operação UpdateGateway para atualizar um gateway de API.