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.

Crea un objeto Deployment

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

Consola

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. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona Versiones.
  6. Haz clic en Agregar implementación.
  7. Especifica los detalles de la implementación en el formulario Agregar una implementación nueva. Debes proporcionar un nombre visible. Los demás elementos son opcionales.

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 63 caracteres, en la que los caracteres válidos son /[a-z][0-9]-/.
  • DISPLAY_NAME: (Obligatorio) El nombre visible de la implementación. Puedes usar cualquier nombre que desees.

Además del nombre visible requerido, 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.

Resultado de muestra:

{
  
}

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

Las implementaciones de API deben estar asociadas con versiones de API.

Pasos por definir.

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.

Consola

Para ver los detalles de una implementación mediante 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. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la implementación.

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 de la implementación.

Resultado de muestra:

{
    xxx
  }

Mostrar lista de implementaciones

En esta sección, se explica cómo enumerar las implementaciones.

Consola

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. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la implementación.

REST

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

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/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.

Resultado de muestra:

{
        
      }

Borra una implementación de API

En esta sección, se explica cómo borrar la implementación de la API.

Consola

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

Para borrar los recursos de 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. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la implementación.
  6. Selecciona Borrar en el menú de acciones.

REST

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

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 la implementación.

Resultado de muestra:

{
        
      }

Editar una implementación

Consola

  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. Si es necesario, usa Buscar para ubicar una API.
  4. Haz clic en una API para ver sus detalles.
  5. Selecciona la versió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"
      '{
        TBD
      {'

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 la implementación que se editará.

Puedes agregar atributos opcionales adicionales para la API si los incluyes en el cuerpo de la solicitud o puedes agregarlos más adelante. Por ejemplo, puedes especificar una descripción, un propietario y un vínculo a la documentación de la API. Para obtener más información, consulta la API del concentrador de APIs.