Sprawdzanie stanu integracji i ustawień

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Na tej stronie opisujemy, jak po włączeniu integracji sprawdzić stan i ustawienia łącznika centrum interfejsów API Apigee Edge w organizacji Apigee Edge.

Sprawdzanie ustawień integracji z łącznikiem centrum interfejsów API

Aby pobrać ustawienia integracji łącznika centralnego interfejsu API dla organizacji, wyślij żądanie GET:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

Gdzie:

• ORG_NAME to nazwa Twojej organizacji Apigee Edge.
• OAUTH_TOKENto token OAuth używany do uwierzytelniania żądania. Więcej informacji o tworzeniu tokena OAuth znajdziesz w artykule Pobieranie tokenów.

Odpowiedź informująca o powodzeniu wygląda mniej więcej tak:

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true potwierdza, że integracja z łącznikiem centrum interfejsów API jest aktywna w organizacji.

"gatewayId" wyświetla nazwę zasobu instancji, z którą jest połączona ta organizacja Apigee Edge.

Sprawdzanie stanu skonsolidowanego

Aby uzyskać skonsolidowany stan, który zawiera szczegółowe informacje o postępach przesyłania, wyślij żądanie GET do interfejsu Edge Management API:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

Gdzie:

• ORG_NAME to nazwa Twojej organizacji Apigee Edge.

Odpowiedź informująca o powodzeniu wygląda mniej więcej tak i pokazuje postęp przesyłania serwerów proxy i środowisk. Poniższy przykład przedstawia fazę Queued:

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

Skonsolidowane pola stanu

Sprawdzanie szczegółowego stanu przesyłania

Szczegółowy stan poszczególnych serwerów proxy interfejsu API lub środowisk albo grupy elementów filtrowanych według stanu możesz sprawdzić za pomocą punktu końcowego /details i parametrów zapytania.

Stan konkretnego produktu

Aby sprawdzić szczegółowy stan konkretnego elementu, użyj parametrów zapytania filter i name. W przypadku serwera proxy interfejsu API o nazwie myproxy w organizacji acme wywołaj interfejs API stanu w ten sposób:

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

W przypadku środowiska o nazwie myenv w organizacji acme wywołaj interfejs API stanu w ten sposób:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

Wywołanie powyższego interfejsu API spowoduje wyświetlenie danych wyjściowych JSON podobnych do tych poniżej w przypadku serwera proxy, który został niedawno przesłany:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

Szczegółowy stan z informacjami o wersji

Informacje o poszczególnych wersjach serwera proxy można uzyskać, podając dodatkowy parametr zapytania showRevisions=true. Wygenerowane dane wyjściowe będą zawierać szczegóły każdej wersji przesłanej dla danego serwera proxy.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

Wywołanie powyższego interfejsu API z parametrem showrevisions spowoduje wyświetlenie danych wyjściowych JSON podobnych do tych poniżej:

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

Stan przesyłania grupy

Stan przesyłania grupy produktów możesz uzyskać, używając filtrów grup z parametrem zapytania state.

Aby sprawdzić stan wszystkich proxy interfejsu API, które w organizacji acme są w stanie failed, wywołaj interfejs API stanu w ten sposób:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

Podobnie, aby uzyskać szczegółową listę wszystkich środowisk, które oczekują na przesłanie w organizacji acme, wywołaj interfejs API stanu w ten sposób:

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

Wynikiem wywołania tego interfejsu API będzie kolekcja JSON poszczególnych elementów stanu pasujących do filtra. Przykład:

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

Parametry zapytania dotyczące szczegółowego stanu

Interfejs API udostępnia 3 parametry zapytania. W wartościach wielkość liter ma znaczenie.

Kombinacje parametrów szczegółowego stanu

W tabeli poniżej znajdziesz możliwe kombinacje parametrów, które można przekazać do interfejsu REST API, aby uzyskać szczegółowy stan. NA oznacza, że parametr zostanie zignorowany. Symbol NULL oznacza, że parametr nie został podany.