Kiểm tra trạng thái và chế độ cài đặt tích hợp

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. Thông tin

Trang này mô tả cách kiểm tra trạng thái và chế độ cài đặt của chế độ tích hợp trình kết nối trung tâm API Apigee Edge trong tổ chức Apigee Edge sau khi bạn bật chế độ này.

Kiểm tra chế độ cài đặt tích hợp trình kết nối trung tâm API

Để truy xuất chế độ cài đặt tích hợp trình kết nối trung tâm API cho một tổ chức, hãy gửi yêu cầu GET để gửi yêu cầu sau:

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

Trong trường hợp:

• ORG_NAME là tên tổ chức Apigee Edge của bạn.
• OAUTH_TOKEN là mã thông báo OAuth dùng để xác thực yêu cầu. Để biết thêm thông tin về cách tạo mã thông báo OAuth, hãy xem phần Lấy mã thông báo.

Phản hồi thành công sẽ có dạng như sau:

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

"enabled": true xác nhận rằng chế độ tích hợp trình kết nối trung tâm API đã được kích hoạt cho tổ chức.

"gatewayId" hiển thị Tên tài nguyên của phiên bản mà tổ chức Apigee Edge này được kết nối.

Kiểm tra trạng thái hợp nhất

Để biết trạng thái tổng hợp bao gồm tiến trình tải lên chi tiết, hãy đưa ra yêu cầu GET đối với Edge Management API:

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

Trong trường hợp:

• ORG_NAME là tên tổ chức Apigee Edge của bạn.

Một phản hồi tổng hợp thành công sẽ có dạng tương tự như sau, cho thấy tiến trình tải lên cho các proxy và môi trường. Ví dụ bên dưới minh hoạ một giai đoạn 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
      }
    }
  }
}

Các trường trạng thái được hợp nhất

Kiểm tra trạng thái tải lên chi tiết

Bạn có thể kiểm tra trạng thái chi tiết của từng môi trường hoặc proxy API riêng lẻ, hoặc một nhóm các mục được lọc theo trạng thái, bằng cách sử dụng điểm cuối /details và các tham số truy vấn.

Trạng thái của một mặt hàng cụ thể

Để kiểm tra trạng thái chi tiết của một mục cụ thể, hãy sử dụng các tham số truy vấn filter và name. Đối với một proxy API có tên là myproxy trong tổ chức acme, hãy gọi API trạng thái như sau:

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

Đối với một môi trường có tên là myenv trong tổ chức acme, hãy gọi API trạng thái như sau:

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

Việc gọi API ở trên sẽ dẫn đến một đầu ra JSON tương tự như sau cho một proxy được tải lên gần đây:

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

Trạng thái chi tiết kèm theo thông tin về bản sửa đổi

Bạn có thể nhận thông tin về từng bản sửa đổi của proxy cho một proxy nhất định bằng cách cung cấp một tham số truy vấn bổ sung showRevisions=true. Kết quả được tạo ở đây sẽ cung cấp thông tin chi tiết về từng bản sửa đổi đã được tải lên cho một proxy nhất định.

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

Khi gọi API ở trên bằng tham số showrevisions, bạn sẽ nhận được một đầu ra JSON tương tự như sau:

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

Trạng thái tải lên theo nhóm

Bạn có thể nhận được trạng thái tải lên cho một nhóm mặt hàng bằng cách sử dụng bộ lọc nhóm với tham số truy vấn state.

Để biết trạng thái của tất cả các proxy API ở trạng thái thất bại trong tổ chức acme, hãy gọi API trạng thái như sau:

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

Tương tự, để nhận danh sách chi tiết về tất cả các môi trường đang chờ tải lên trong tổ chức acme, hãy gọi API trạng thái như sau:

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

Kết quả của việc gọi API này sẽ là một tập hợp JSON gồm các mục trạng thái riêng lẻ khớp với bộ lọc. Ví dụ:

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

Tham số truy vấn để biết trạng thái chi tiết

API này cung cấp 3 tham số truy vấn. Các giá trị này có phân biệt chữ hoa chữ thường.

Các tổ hợp tham số cho trạng thái chi tiết

Bảng dưới đây giải thích các tổ hợp thông số có thể được truyền đến REST API để nhận được trạng thái chi tiết. NA cho biết tham số sẽ bị bỏ qua. NULL cho biết bạn chưa cung cấp tham số.