Verifique o estado de implementação do proxy de API através da API

Esta secção descreve como verificar o estado de implementação de um proxy de API através das APIs Apigee.

  1. Implemente um proxy de API de teste, conforme explicado em Crie e implemente um novo proxy de API.
  2. Localize o ficheiro JSON com a chave da conta de serviço de administrador da organização do Apigee. Esta conta de serviço e chave foram criadas em Ativar acesso do sincronizador.
  3. Execute estes dois comandos para obter um token:
    export GOOGLE_APPLICATION_CREDENTIALS=org-admin-service-account-file
    export TOKEN=$(gcloud auth application-default print-access-token)

    Onde org-admin-service-account-file é o caminho no seu sistema para a chave da conta de serviço que transferiu com a função Administrador da organização Apigee.

  4. Chame a API Revisions com as seguintes partes:
    • URL de base: https://apigee.googleapis.com/v1
    • URL do ponto final: /organizations/my-organization/environments/test/apis/myproxy/revisions/1/deployments
    • Protocolo: HTTPS
    • Método: GET
    • Headers: "Authorization: Bearer $TOKEN"

    O exemplo seguinte chama a API Deployment Revisions com estas definições através de curl:

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

    Deve receber uma resposta semelhante à seguinte:

    {
      "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
            }
          ]
        }
      ]
    }

    Esta resposta de exemplo mostra que o estado do proxy da API é READY, o que indica uma implementação bem-sucedida.

    Se receber uma resposta vazia ou um erro, verifique se:

    • Usou o URL base correto. Tenha em atenção que o URL base híbrido não é igual ao URL base da API Edge. Use https://apigee.googleapis.com/v1.
    • Usou o URL do ponto final correto. Tenha em atenção que a revisão é "1" e o ponto final é /organizations/my_organization/environments/test/apis/myproxy/revisions/1/deployments. Se especificar uma revisão que não existe, o pedido resulta numa resposta vazia, como a seguinte:
      { }
    • Tem autorizações para aceder à organização que especifica no pedido.
    • O seu token não expirou. Se tiver, regenere um novo, conforme descrito em Obtenha uma chave de acesso OAuth 2.0.
    • Envolveu o cabeçalho "Authorization: Bearer $TOKEN" entre aspas.