Verifica el estado de implementación del proxy de API mediante la API

En esta sección, se describe cómo verificar el estado de implementación de un proxy de API mediante las API de Apigee.

  1. Implementa un proxy de API de prueba como se explica en Crea e implementa un proxy de API nuevo.
  2. Ubica el archivo JSON con la clave de la cuenta de servicio de administrador de la organización de Apigee. La cuenta de servicio y la clave se crearon en Habilita el acceso del sincronizador.
  3. Ejecuta estos dos comandos para obtener un token:
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
    export TOKEN=$(gcloud auth application-default print-access-token)

    En el ejemplo anterior org-admin-service-account-file es la ruta en tu sistema a la clave de la cuenta de servicio que descargaste con la función Administrador de la organización de Apigee.

  4. Llama a la API de revisiones con las siguientes partes:
    • URL base: https://apigee.googleapis.com/v1
    • URL del extremo: /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocolo: HTTPS
    • Método: GET
    • Encabezados: "Authorization: Bearer $TOKEN"

    En el siguiente ejemplo, se llama a la API de revisiones de implementación con estas opciones de configuración mediante curl:

    curl "https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments" \
    -X GET -H "Authorization: Bearer $TOKEN"

    Deberías recibir una respuesta similar a la que figura a continuación:

    {
      "environment": "test",
      "apiProxy": "myproxy",
      "revision": "1",
      "deployStartTime": "1616787712821",
      "state": "READY",
      "instances": [
        {
          "instance": "hybrid-docs-id",
          "deployedRevisions": [
            {
              "revision": "2",
              "percentage": 100
            }
          ],
          "deployedRoutes": [
            {
              "basepath": "/myproxy",
              "envgroup": "test-group",
              "environment": "test",
              "percentage": 100
            }
          ]
        }
      ]
    }

    En esta respuesta de ejemplo, se muestra el estado del proxy de API: READY, que indica una implementación exitosa.

    Si obtienes una respuesta vacía o un error, verifica lo siguiente:

    • Utilizaste la URL base correcta. Ten en cuenta que la URL base híbrida no es la misma que la URL base de la API de Edge. Usa https://apigee.googleapis.com/v1.
    • Usaste la URL de extremo correcta. Ten en cuenta que la revisión es “1” y el extremo es /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Si especificas una revisión que no existe, la solicitud da como resultado una respuesta vacía como la siguiente:
      { }
    • Tienes los permisos para acceder a la organización que especificaste en la solicitud.
    • Tu token no venció. Si venció, vuelve a generar uno nuevo como se describe en Obtén un token de acceso de OAuth 2.0.
    • Debes unir el encabezado "Authorization: Bearer $TOKEN" entre comillas.