Documentación de Oracle Cloud Infrastructure

Actualización de un gateway de API o un despliegue de API

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

Después de crear un gateway y de desplegar una API en él mediante la creación de un despliegue, puede decidir si desea cambiar uno o ambos. Por ejemplo, puede que desee cambiar el nombre del gateway de API o las etiquetas que tiene aplicadas, o bien cambiar una especificación de despliegue de API para agregar backends adicionales al despliegue de API.

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

Puede actualizar gateways y despliegue de API mediante la consola, la CLI y la API. Puede actualizar una especificación de despliegue de API mediante la consola o editando un archivo JSON.

    1. Abra el menú de navegación y haga clic en Servicios para desarrolladores. En Gestión de API, haga clic en Gateways.
    2. Seleccione el compartimento que contiene el gateway de API o el despliegue de API que desea actualizar.
    3. Haga clic en el nombre del gateway de API para abrir la página de detalles del gateway de API.

    4. Para actualizar un gateway de API, realice cualquiera de las siguientes acciones:

      • Haga clic en 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 que utiliza el gateway de API. Tenga en cuenta que los recursos de certificado de gateway de API y los recursos de certificado de servicio de certificados solo se muestran si están disponibles en el compartimento seleccionado. Consulte Configuración de dominios personalizados y certificados TLS.
        • Cambie 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 autoridades de certificación incluidos en el almacén de confianza del gateway de API como CA personalizadas y grupos de autoridades de certificación personalizadas (además del grupo de autoridades de certificación por defecto). Consulte Customizing Trust Stores for TLS Certificate Verification.
      • Haga clic en Mover recurso para mover el gateway de API a otro compartimento.
      • Haga clic en el separador Etiquetas para ver y editar las etiquetas aplicadas al gateway de API y haga clic en Agregar etiquetas para aplicar más etiquetas al gateway de API.

    5. Para actualizar un despliegue de API, realice las siguientes acciones:

      1. En la página Detalles de gateway, seleccione Despliegues en la lista Recursos.
      2. Haga clic en el menú Acciones (Menú Acciones) del despliegue de API que desea actualizar y realice cualquiera de las siguientes acciones:

        • Seleccione Editar para cambiar el nombre del despliegue de API o para sustituir la especificación de despliegue de API original. Puede cambiar la especificación de despliegue de la API original seleccionando una de las siguientes opciones:

          • Desde cero: cambie las propiedades de especificación de despliegue de API proporcionando valores en la consola.
          • Cargar una API existente: cambie las propiedades de especificación de despliegue de API mediante la carga de un archivo JSON de sustitución.

          Para obtener más información sobre la definición de especificaciones de despliegue de API, consulte Creación de una especificación de despliegue de API. Evite introducir información confidencial.

        • Seleccione Mover recurso para mover el despliegue de la API a otro compartimento.
        • Seleccione Agregar etiquetas y Ver etiquetas para cambiar y ver las etiquetas aplicadas al despliegue de API.

  • Siga estos pasos para actualizar gateways y despliegues de API existentes con 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 Listado de gateways de API y despliegues 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>

    3. Para actualizar un despliegue de API existente:

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

        oci api-gateway deployment update --deployment-id <deployment-ocid> --specification file:///<filename>

        donde:

        • <deployment-ocid> es el OCID del despliegue de la API que se actualizará. Para conocer el OCID del despliegue de la API, consulte Listado de gateways de API y despliegues de API.
        • <filename> es la ubicación relativa y el nombre de archivo del archivo JSON que contiene la especificación de despliegue de API de sustitución. Por ejemplo, replacement-specification.json. Para obtener más información sobre la definición de especificaciones de despliegue de API, consulte Creación de una especificación de despliegue de API.

        Por ejemplo:

        oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json

        La respuesta al comando incluye:

        • Estado del ciclo de vida (por ejemplo, ACTIVE, FAILED).
        • ID de la solicitud de trabajo para actualizar el despliegue 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 despliegue de la API esté activo (o que la solicitud haya fallado), incluya uno o los dos parámetros siguientes:

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

        Por ejemplo:

        oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json --wait-for-state ACTIVE

      2. (Opcional) Para ver el estado de la solicitud de trabajo que está actualizando el despliegue 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 despliegue 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 despliegue 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 despliegue de API se ha actualizado, introduzca el siguiente comando y confirme que las propiedades del despliegue de API son las que esperaba:

        oci api-gateway deployment get --deployment-id <deployment-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: