ตรวจสอบสถานะและการตั้งค่าการผสานรวม

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

หน้านี้อธิบายวิธีตรวจสอบสถานะและการตั้งค่าการผสานรวมตัวเชื่อมต่อฮับ API ของ Apigee Edge ในองค์กร Apigee Edge หลังจากเปิดใช้แล้ว

ตรวจสอบการตั้งค่าการผสานรวมตัวเชื่อมต่อฮับ API

หากต้องการดึงการตั้งค่าการผสานรวมตัวเชื่อมต่อฮับ API สำหรับองค์กร ให้ส่งคำขอ GET เพื่อส่งคำขอต่อไปนี้

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

สถานที่:

• ORG_NAME คือชื่อองค์กร Apigee Edge ของคุณ
• OAUTH_TOKENคือโทเค็น OAuth ที่ใช้เพื่อตรวจสอบสิทธิ์คำขอ ดูข้อมูลเพิ่มเติมเกี่ยวกับ การสร้างโทเค็น OAuth ได้ที่รับโทเค็น

การตอบกลับที่สำเร็จจะมีลักษณะคล้ายกับตัวอย่างต่อไปนี้

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

"enabled": true ยืนยันว่าได้เปิดใช้งานการผสานรวมตัวเชื่อมต่อฮับ API สำหรับองค์กรแล้ว

"gatewayId" จะแสดงชื่อทรัพยากรของอินสแตนซ์ที่เชื่อมต่อกับองค์กร Apigee Edge นี้

การตรวจสอบสถานะการรวม

หากต้องการสถานะแบบรวมที่มีความคืบหน้าในการอัปโหลดโดยละเอียด ให้ส่งGETคำขอไปยัง Edge Management API ดังนี้

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

สถานที่:

• ORG_NAME คือชื่อองค์กร Apigee Edge ของคุณ

การตอบกลับที่รวมกันสำเร็จจะมีลักษณะคล้ายกับตัวอย่างต่อไปนี้ ซึ่งแสดงความคืบหน้าในการอัปโหลดพร็อกซีและสภาพแวดล้อม ตัวอย่างด้านล่างแสดงเฟส 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
      }
    }
  }
}

ฟิลด์สถานะแบบรวม

การตรวจสอบสถานะการอัปโหลดโดยละเอียด

คุณสามารถตรวจสอบสถานะโดยละเอียดของพร็อกซี API หรือสภาพแวดล้อมแต่ละรายการ หรือกลุ่มรายการที่กรองตามสถานะได้โดยใช้/detailsปลายทางและพารามิเตอร์การค้นหา

สถานะของสินค้าที่เฉพาะเจาะจง

หากต้องการตรวจสอบสถานะโดยละเอียดของสินค้าที่เฉพาะเจาะจง ให้ใช้พารามิเตอร์การค้นหา filter และ name สำหรับพร็อกซี API ที่ชื่อ myproxy ในองค์กร acme ให้เรียก API สถานะดังนี้

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

สำหรับสภาพแวดล้อมชื่อ myenv ในองค์กร acme ให้เรียก API สถานะดังนี้

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

การเรียกใช้ API ข้างต้นจะส่งผลให้เกิดเอาต์พุต JSON ที่คล้ายกับเอาต์พุตต่อไปนี้สำหรับพร็อกซีที่อัปโหลดเมื่อเร็วๆ นี้

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

สถานะโดยละเอียดพร้อมข้อมูลการแก้ไข

คุณสามารถรับข้อมูลเกี่ยวกับการแก้ไขพร็อกซีแต่ละรายการสำหรับพร็อกซีที่ต้องการได้โดยระบุพารามิเตอร์การค้นหาเพิ่มเติม showRevisions=true เอาต์พุตที่สร้างขึ้นที่นี่จะแสดงรายละเอียดเกี่ยวกับการแก้ไขแต่ละครั้งที่อัปโหลดสำหรับพร็อกซีที่ระบุ

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

การเรียกใช้ API ข้างต้นด้วยพารามิเตอร์ showrevisions จะส่งผลให้เอาต์พุต JSON คล้ายกับต่อไปนี้

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

สถานะการอัปโหลดกลุ่ม

คุณดูสถานะการอัปโหลดของกลุ่มสินค้าได้โดยใช้ตัวกรองกลุ่มกับพารามิเตอร์การค้นหา state

หากต้องการดูสถานะของพร็อกซี API ทั้งหมดที่อยู่ในสถานะล้มเหลวในองค์กร acme ให้เรียกใช้ API สถานะดังนี้

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

ในทำนองเดียวกัน หากต้องการดูรายการโดยละเอียดของสภาพแวดล้อมทั้งหมดที่รอการอัปโหลดในองค์กร acme ให้เรียกใช้ API สถานะดังนี้

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

ผลลัพธ์ของการเรียก API นี้จะเป็นคอลเล็กชัน JSON ของรายการสถานะแต่ละรายการที่ตรงกับตัวกรอง ตัวอย่าง

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

พารามิเตอร์การค้นหาสำหรับสถานะโดยละเอียด

API มีพารามิเตอร์การค้นหา 3 รายการ ค่าจะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

ชุดค่าผสมของพารามิเตอร์สำหรับสถานะโดยละเอียด

ตารางด้านล่างอธิบายชุดค่าผสมของพารามิเตอร์ที่เป็นไปได้ซึ่งสามารถส่งไปยัง REST API เพื่อดูสถานะโดยละเอียด NA แสดงว่าระบบจะไม่สนใจพารามิเตอร์ NULL หมายความว่าไม่มีการระบุพารามิเตอร์