Sprawdzanie stanu integracji i ustawień

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

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

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

Aby pobrać ustawienia integracji z łącznikiem centrum interfejsów API w 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_TOKEN to token OAuth używany do uwierzytelniania żądania. Więcej informacji o tworzeniu tokena OAuth znajdziesz w artykule na temat pobierania tokenów.

Odpowiedź informująca o powodzeniu będzie 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ą połączona jest ta organizacja Apigee Edge.

Sprawdzanie stanu zbiorczego

Aby uzyskać stan zbiorczy zawierający szczegółowe informacje o postępie 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 będzie wyglądać mniej więcej tak. 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
      }
    }
  }
}

Pola stanu zbiorczego

Sprawdzanie szczegółowego stanu przesyłania

Szczegółowy stan poszczególnych 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 elementu

Aby sprawdzić szczegółowy stan konkretnego elementu, użyj parametrów zapytania filter i name. Aby wywołać interfejs API stanu dla proxy interfejsu API o nazwie myproxy w organizacji acme, użyj tego polecenia:

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

Aby wywołać interfejs API stanu dla środowiska o nazwie myenv w organizacji acme, użyj tego polecenia:

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

Wywołanie powyższego interfejsu API spowoduje wygenerowanie 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

Możesz uzyskać informacje o poszczególnych wersjach serwera proxy, podając dodatkowy parametr zapytania showRevisions=true. Wygenerowane dane wyjściowe będą zawierać szczegółowe informacje o każdej wersji, która została przesłana 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 wygenerowanie 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

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

Aby uzyskać stan wszystkich serwerów proxy API, które są w stanie failed w organizacji acme, 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, które pasują 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. Wartości są wrażliwe na wielkość liter.

Kombinacje parametrów dotyczące szczegółowego stanu

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