Entegrasyon durumunu ve ayarlarını kontrol etme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Bu sayfada, Apigee Edge API hub bağlayıcı entegrasyonu etkinleştirildikten sonra Apigee Edge kuruluşunuzdaki durumunun ve ayarlarının nasıl kontrol edileceği açıklanmaktadır.

API hub bağlayıcı entegrasyon ayarlarını kontrol etme

Bir kuruluşun API hub bağlayıcı entegrasyon ayarlarını almak için aşağıdaki isteği göndermek üzere bir GET isteği oluşturun:

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

Burada:

• ORG_NAME, Apigee Edge kuruluşunuzun adıdır.
• OAUTH_TOKEN, isteğin kimliğini doğrulamak için kullanılan OAuth jetonudur. OAuth jetonu oluşturma hakkında daha fazla bilgi için Jetonları alma başlıklı makaleyi inceleyin.

Başarılı bir yanıt aşağıdakine benzer:

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

"enabled": true, API hub bağlayıcı entegrasyonunun kuruluş için etkinleştirildiğini onaylar.

"gatewayId", bu Apigee Edge kuruluşunun bağlı olduğu örnek kaynak adını gösterir.

Birleştirilmiş durumu kontrol etme

Ayrıntılı yükleme ilerleme durumunu içeren birleştirilmiş durum için Edge Management API'ye GET isteği gönderin:

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

Burada:

• ORG_NAME, Apigee Edge kuruluşunuzun adıdır.

Başarılı bir birleştirilmiş yanıt, aşağıdakine benzer şekilde görünür ve proxy'ler ile ortamlar için yükleme ilerleme durumunu gösterir. Aşağıdaki örnekte bir Queued aşaması gösterilmektedir:

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

Birleştirilmiş durum alanları

Ayrıntılı yükleme durumunu kontrol etme

/details uç noktasını ve sorgu parametrelerini kullanarak tek bir API proxy'sinin veya ortamın ya da duruma göre filtrelenmiş bir öğe grubunun ayrıntılı durumunu kontrol edebilirsiniz.

Belirli bir öğenin durumu

Belirli bir öğenin ayrıntılı durumunu kontrol etmek için filter ve name sorgu parametrelerini kullanın. acme kuruluşundaki myproxy adlı bir API proxy'si için durum API'sini aşağıdaki gibi çağırın:

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

acme kuruluşundaki myenv adlı bir ortam için durum API'sini aşağıdaki gibi çağırın:

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

Yukarıdaki API'yi çağırdığınızda, yakın zamanda yüklenen bir proxy için aşağıdakine benzer bir JSON çıktısı elde edilir:

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

Düzeltme bilgilerini içeren ayrıntılı durum

Ek bir sorgu parametresi showRevisions=true sağlayarak belirli bir proxy'nin proxy düzeltmesi hakkında bilgi edinmek mümkündür. Burada oluşturulan çıkış, belirli bir proxy için yüklenen her düzeltmeyle ilgili ayrıntıları sağlar.

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

Yukarıdaki API'yi showrevisions parametresiyle çağırdığınızda aşağıdaki JSON çıktısına benzer bir sonuç elde edersiniz:

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

Grup yükleme durumu

state sorgu parametresiyle grup filtrelerini kullanarak bir grup öğenin yükleme durumlarını alabilirsiniz.

acme kuruluşunda başarısız durumdaki tüm API proxy'lerinin durumu için durum API'sini aşağıdaki gibi çağırın:

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

Benzer şekilde, kuruluş acme'da yüklenmeyi bekleyen tüm ortamların ayrıntılı bir listesini almak için durum API'sini aşağıdaki gibi çağırın:

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

Bu API'nin çağrılması sonucunda, filtreyle eşleşen tek tek durum öğelerinin JSON koleksiyonu elde edilir. Örnek:

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

Ayrıntılı durum için sorgu parametreleri

API üç sorgu parametresi sağlar. Değerler büyük/küçük harfe duyarlıdır.

Ayrıntılı durum için parametre kombinasyonları

Aşağıdaki tabloda, ayrıntılı durum bilgisi almak için REST API'ye iletilebilecek olası parametre kombinasyonları açıklanmaktadır. NA, parametrenin yoksayılacağını gösterir. NULL, parametrenin sağlanmadığını gösterir.