Sử dụng API quản lý giám sát API

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Sử dụng API quản lý Giám sát API để thực hiện các nhiệm vụ sau.

Việc cần làm Thông tin khác
Quản lý cảnh báo cho tính năng Giám sát API
Quản lý bộ sưu tập cho tính năng Giám sát API
Xem nhật ký Theo dõi API ở nhiều cấp
Xem các chỉ số của API Giám sát

Hạn mức lệnh gọi API

Tất cả API Theo dõi API đều thực thi hạn mức giới hạn số lần bạn có thể gọi API trong một phút. Ví dụ: API Tạo bộ sưu tập giới hạn bạn ở mức 6 lệnh gọi mỗi phút.

Không phải API nào cũng có cùng hạn mức hạn mức. Hãy xem tài liệu tham khảo API về từng API để xác định giới hạn của API đó.

Sử dụng curl

Các ví dụ về API trong tài liệu này sử dụng curl để minh hoạ cách sử dụng tính năng Giám sát API bằng API. curl là một công cụ dòng lệnh nguồn mở để chuyển dữ liệu bằng cú pháp URL, hỗ trợ các giao thức phổ biến như HTTP và HTTPS. Để biết thông tin về cách tải xuống và sử dụng curl, hãy xem https://curl.haxx.se/.

Bảng sau đây tóm tắt các tuỳ chọn dòng lệnh curl được dùng trong các ví dụ.

Tuỳ chọn Nội dung mô tả
-d '{}'

--data @filename

Xác định nội dung yêu cầu, được truyền trực tiếp hoặc bằng cách chỉ định tên tệp.
-H

--header

Xác định tiêu đề yêu cầu. Bạn phải truyền các thông tin sau trong tiêu đề yêu cầu:
  • Mã thông báo OAuth 2.0 để xác thực người dùng bằng tiêu đề Authorization, như mô tả trong phần Lấy mã truy cập OAuth 2.0.
  • Các loại nội dung mà ứng dụng hỗ trợ bằng cách sử dụng tiêu đề Accept.
  • Loại nội dung của nội dung yêu cầu được gửi khi tạo hoặc cập nhật tài nguyên (POST, PATCH, PUT) bằng tiêu đề Content-Type.
-i Hiển thị thêm thông tin, chẳng hạn như tiêu đề, trong phản hồi.
-X Chỉ định loại yêu cầu (GET, POST, v.v.).

Lấy mã truy cập OAuth 2.0

Apigee Edge hỗ trợ OAuth 2.0 để xác thực người dùng. Với OAuth 2.0, bạn sẽ trao đổi thông tin xác thực Apigee Edge để lấy mã truy cập và mã làm mới. Sau đó, bạn có thể sử dụng các mã này để thực hiện các lệnh gọi bảo mật đến API Apigee Edge. Sau khi nhận được mã thông báo, bạn không cần trao đổi lại thông tin xác thực cho đến khi mã thông báo hết hạn. Mã làm mới cho phép bạn duy trì "phiên" với máy chủ trong thời gian dài hơn mà không cần cung cấp thông tin xác thực. Để biết thêm thông tin về mã thông báo truy cập, hãy xem bài viết Sử dụng OAuth2 để truy cập vào API quản lý.

Bằng cách sử dụng thông tin xác thực Apigee Edge, bạn có thể lấy mã truy cập và mã làm mới OAuth 2.0 để truy cập vào các tài nguyên Apigee Edge bằng tiện ích get_token của Apigee.

Cách lấy mã truy cập OAuth 2.0:

  1. Cài đặt tiện ích get_token. Để biết thông tin về cách cài đặt tiện ích get_token, hãy xem phần Sử dụng get_token.

  2. Thực thi get_token để lấy mã truy cập OAuth 2.0.

    Trong lần đầu tiên bạn nhập lệnh hoặc nếu mã thông báo làm mới đã hết hạn, get_token sẽ nhắc bạn nhập tên người dùng, mật khẩu và mã xác thực hai yếu tố gồm 6 chữ số. Nhập từng giá trị khi được nhắc. Nếu bạn chưa bật tính năng xác thực hai yếu tố, chỉ cần nhấn Enter khi được nhắc.

  3. Sao chép mã thông báo OAuth 2.0 và lưu trữ mã đó trong một biến, chẳng hạn như ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Khi bạn gọi API Theo dõi API, hãy truyền mã truy cập OAuth 2.0 trong tiêu đề HTTP bằng tiêu đề Authorization (Uỷ quyền). Ví dụ:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...