Documentación de Oracle Cloud Infrastructure

Actualización de un gateway de API

Descubra cómo modificar gateways de API que ha creado anteriormente con el servicio API Gateway.

Después de crear un gateway de API, puede que decida cambiarlo. Por ejemplo, puede que desee cambiar el nombre del gateway de API o las etiquetas aplicadas a él.

Tenga en cuenta que hay algunas propiedades de gateways de API para las que no puede cambiar los valores originales.

Puede actualizar gateways de API mediante la consola, la CLI y la API.

    1. En la página de lista Gateways, busque el gateway de API que desea actualizar. Si necesita ayuda para buscar la página de lista o el gateway de API, consulte Listado de gateways de API.
    2. En el menú Acciones (tres puntos) del gateway de API:
      • Seleccione Editar para cambiar cualquiera de las siguientes propiedades de gateway de API:
        • Cambie el nombre del gateway de API. Evite introducir información confidencial.
        • Active o desactive el uso de grupos de seguridad de red (NSG) para controlar el acceso al gateway de API y desde él mediante reglas de seguridad definidas para los NSG que especifique (hasta un máximo de cinco grupos de seguridad de red). Puede utilizar reglas de seguridad definidas para NSG en lugar de las definidas para listas de seguridad o además de ellas. Los NSG pueden pertenecer al mismo compartimento que el gateway de API, pero no tienen que hacerlo. Consulte Grupos de seguridad de red.
        • Cambie el certificado TLS y el nombre de dominio utilizados por el gateway de API. Tenga en cuenta que los recursos de certificado de API Gateway y los recursos de certificado de servicio Certificates solo se muestran si están disponibles en el compartimento seleccionado. Consulte Configuración de dominios personalizados y certificados TLS.
        • Cambiar los valores de configuración de la caché de respuesta. Consulte Almacenamiento en caché de respuestas para mejorar el rendimiento.
        • Cambie los grupos de autoridades de certificación (CA) y CA incluidos en el almacén de confianza del gateway de API como CA personalizadas y grupos de CA personalizadas (además del grupo de CA por defecto). Consulte Customizing Trust Stores for TLS Certificate Verification.
      • Seleccione Mover recurso para mover el gateway de API a otro compartimento.
      • Seleccione el separador Etiquetas para ver y editar las etiquetas aplicadas al gateway de API y seleccione Agregar etiquetas para aplicar más etiquetas al gateway de API.

  • Para actualizar gateways de API existentes mediante la CLI:

    1. Configure su entorno de cliente para usar la CLI ( Configuración del entorno de cliente para utilizar la CLI para el desarrollo de gateway de API).

    2. Para actualizar un gateway de API existente:

      1. Abra un símbolo del sistema y ejecute oci api-gateway gateway update para actualizar el gateway de API:

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

        donde:

        • <gateway-ocid> es el OCID del gateway de API que se va a actualizar. Para conocer el OCID del gateway de API, consulte Enumeración de gateways de API.
        • <property-to-update> es la propiedad que se va a actualizar. Tenga en cuenta que solo puede cambiar los valores de display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags y defined-tags (y certificate-id> si se ha definido originalmente para el gateway de API). El resto de valores deben ser idénticos a los valores de la definición de gateway original.
        • <property-value> es el nuevo valor de la propiedad que desea cambiar.

        Por ejemplo:

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

        La respuesta al comando incluye:

        • Estado del ciclo de vida (por ejemplo, ACTIVE, FAILED).
        • ID de la solicitud de trabajo para actualizar el gateway de API (los detalles de las solicitudes de trabajo están disponibles durante siete días tras la finalización, cancelación o fallo).

        Si desea que el comando espere para devolver el control hasta que el gateway de API esté activo (o la solicitud falle), incluya uno o los dos parámetros siguientes:

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

        Por ejemplo:

        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 el estado de la solicitud de trabajo que está actualizando el gateway de API, introduzca:

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

      3. (Opcional) Para ver los logs de la solicitud de trabajo que está actualizando el gateway de API, introduzca:

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

      4. (Opcional) Si falla la solicitud de trabajo que está actualizando el gateway de API y desea revisar los logs de errores, introduzca:

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

      5. (Opcional) Para verificar que el gateway de API se ha actualizado, introduzca el siguiente comando y confirme que las propiedades del gateway de API son las que esperaba:

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

    Para obtener más información sobre el uso de la CLI, consulte Interfaz de línea de comandos (CLI). Para obtener una lista completa de los indicadores y las opciones disponibles para los comandos de la CLI, consulte Ayuda de CLI.

  • Ejecute la operación UpdateGateway para actualizar un gateway de API.