Administrar las implementaciones

Esta página se aplica a Apigee y Apigee Hybrid.

En este documento, se describe cómo crear y administrar implementaciones de API. Consulta también Introducción a las implementaciones de API. Después de crear una entidad de implementación, puedes vincularla a una o más versiones de la API.

Crea un objeto Deployment

Puedes crear una entidad de implementación en la consola o con la API de REST.

Console

Para crear una implementación nueva, sigue estos pasos:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. En la pestaña Implementaciones, haz clic en Agregar implementación.
  6. Especifica los detalles de la implementación en el formulario Crear implementación:
    • ID de implementación: Haz clic en Especificar ID único para proporcionar, de manera opcional, un ID único para la implementación. Si omites el ID, el concentrador de APIs creará uno por ti. El ID debe tener entre 4 y 500 caracteres, y los caracteres válidos son /[A-Z][a-z][0-9]-/.
    • Nombre de la implementación: (Obligatorio) Proporciona un nombre visible para la implementación.
    • Descripción: Ingresa una descripción de la implementación.
    • Tipo de implementación: Selecciona el tipo de implementación. Los valores posibles se definen en un atributo del sistema, y puedes modificarlos en Administrar atributos.
    • URI de recurso: (Obligatorio) Proporciona un URI al recurso del entorno de ejecución. Este URI se puede usar para administrar el recurso. Por ejemplo, si el recurso del entorno de ejecución es un proxy de la API de Apigee, este campo debe contener el URI a la interfaz de usuario de administración del proxy.
    • Entorno: El entorno asignado a esta implementación. El entorno se asigna al atributo de entorno definido por el sistema.
    • Documentación: Ingresa un vínculo a la documentación de la implementación.
    • SLO: Proporciona el SLO para esta implementación. Esto se asigna al atributo definido por el sistema de SLO. Puedes modificar los valores de este atributo en Administrar atributos.
    • Extremos: (Obligatorio) Proporciona los extremos en los que este recurso de implementación escucha las solicitudes a la API. Puede ser una lista de URI completos, nombres de host o direcciones IP.
    • Vincular a una versión: Vincula la implementación a una o más versiones de la API.
    • Atributos definidos por el usuario: Son pares clave-valor definidos por el usuario. Puedes agregar atributos definidos por el usuario en Administrar atributos.
  7. Haz clic en Crear.

REST

Para agregar una implementación nueva con la API de Crear una implementación, haz lo siguiente:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • DEPLOYMENT_ID: (Opcional) El identificador de la implementación. Si no se proporciona, se usará un ID generado por el sistema. El nombre debe ser una string de 4 a 500 caracteres, en la que los caracteres válidos son /[a-z][A-Z][0-9]-_/.
  • DISPLAY_NAME: (Obligatorio) El nombre visible de la implementación. Puedes usar cualquier nombre que desees.
  • Atributos opcionales: Además del nombre visible obligatorio, puedes adjuntar atributos y entidades opcionales a una implementación. Estos elementos adicionales se describen en la descripción del recurso de implementación en la referencia de la API de REST.

Vincula una implementación a una versión de la API

Una versión puede tener una o más implementaciones vinculadas a ella. En esta sección, se explica cómo vincular las implementaciones a las versiones. Puedes vincular las implementaciones a una versión cuando la creas o puedes editar una versión existente para vincular las implementaciones a ella. Consulta Crea una versión de API y Edita una versión.

Para vincular una implementación a una versión nueva o existente, esta ya debe existir. Consulta Crea una implementación.

Console

Para agregar una implementación a una versión, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al centro de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Selecciona una API
  5. En la tabla Versiones, busca la versión que deseas editar.
  6. Selecciona Editar en el menú Acciones que se encuentra en el lado derecho de la fila de la versión o selecciona la versión y haz clic en Editar versión en la página de detalles.
  7. En Vincular a una implementación, selecciona una o más implementaciones para vincularlas a la versión y haz clic en Aceptar.
  8. Haz clic en Guardar.

REST

Ejemplo de cómo agregar una implementación a una versión:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • API_NAME: El nombre de la API que tiene la versión que deseas editar.
  • VERSION_ID: El ID único de la versión que se editará.
  • DEPLOYMENTS: Es el nombre de recurso completamente calificado de una o más implementaciones. Por ejemplo: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

Mostrar lista de implementaciones

En esta sección, se explica cómo enumerar las implementaciones. Puedes enumerar todas las implementaciones asociadas con todas las versiones de una API o enumerar todas las implementaciones asociadas con una versión específica.

Console

Para enumerar las implementaciones con la IU, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la pestaña Implementaciones para ver una lista de todas las implementaciones asociadas con la API.
  6. En la pestaña Versiones, selecciona una versión si deseas ver las implementaciones asociadas con esa versión.

REST

Para enumerar todas las implementaciones, usa la API de Enumera implementaciones:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.

Obtén detalles sobre la implementación

En esta sección, se explica cómo obtener los detalles sobre una implementación de la API.

Console

Para ver los detalles de una implementación, sigue estos pasos:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la pestaña Implementaciones para ver una lista de todas las implementaciones asociadas con la API.
  6. Selecciona la implementación para ver su página de detalles.

REST

Para ver los detalles de una implementación, usa la API Obtén detalles de la implementación:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • DEPLOYMENT_ID: El ID único de la implementación.

Borra una implementación de API de una API

En esta sección, se explica cómo borrar la implementación de la API. Cuando borras una implementación de API de una API, primero se desvincula de todas sus versiones y, luego, se borra de la API. Una vez que se borre una implementación, ya no aparecerá en la lista de implementaciones y no podrás filtrar las APIs en función de la implementación borrada.

Console

Para borrar una implementación con la IU, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la pestaña Implementaciones para ver una lista de todas las implementaciones asociadas con la API.
  6. Busca la implementación que deseas borrar.
  7. Selecciona Borrar en el menú Acción de la implementación.

REST

Para borrar una implementación del concentrador de APIs, usa la API Borrar implementación:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • DEPLOYMENT_ID: el ID de único de la implementación que se borrará.

Desvincula una implementación de API de una API o versión

En esta sección, se explica cómo desvincular una implementación de API de una API o versión. Si desvinculas una implementación de una API, esta se desvinculará de todas las versiones de la API. Cuando se desvincula una implementación, esta ya no aparece en la lista de implementaciones.

Console

Para desvincular una implementación de una API con la IU, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la pestaña Implementaciones para ver una lista de todas las implementaciones asociadas con la API.
  6. Busca la implementación que deseas desvincular.
  7. Selecciona Desvincular de la API en el menú Acción de la implementación.

Para desvincular una implementación de una versión con la IU, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona una versión.
  6. En la sección Implementaciones, busca la implementación que deseas desvincular.
  7. Selecciona Desvincular de la versión en el menú Acción de la implementación.

REST

Para borrar un recurso de API del concentrador de APIs, usa la API Borrar implementación:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • DEPLOYMENT_ID: el ID de único de la implementación que se borrará.

Editar una implementación

En esta sección, se explica cómo editar una implementación.

Console

  1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en APIs.
  3. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la pestaña Implementaciones para ver una lista de todas las implementaciones asociadas con la API.
  6. Busca la implementación que deseas editar.
  7. Selecciona Editar en el menú Acción de la implementación o haz clic en la implementación y, luego, en Editar implementación en el panel de detalles de la implementación.

REST

Para editar una implementación, usa la API de implementación de parches:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • DEPLOYMENT_ID: El ID único de la implementación que se editará.
  • DEPLOYMENT_ATTRIBUTES: Adjunta los atributos que deseas modificar en el cuerpo de la solicitud. Los atributos editables se describen en la descripción del recurso de implementación en la referencia de la API de REST.