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 tác 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ý Giám sát API ở các cấp khác nhau
Xem các chỉ số Giám sát API

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

Tất cả API giám sát API đều thực thi một hạn mức giới hạn số lần bạn có thể gọi API mỗi phút. Ví dụ: API Tạo bộ sưu tập giới hạn 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ãy xem tài liệu tham khảo API trên mỗi 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 với 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 truy cập vào https://curl.haxx.se/.

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

Lựa chọn 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 đề của yêu cầu. Bạn phải chuyển các thông tin sau vào tiêu đề của 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 được ứ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êm thông tin, chẳng hạn như tiêu đề, trong câu trả lời.
-X Chỉ định loại yêu cầu (GET, POST, v.v.).

Nhận 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ể dùng mã này để thực hiện 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 đăng nhập của mình 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 đăng nhập của bạn. Để biết thêm thông tin về mã truy cập, hãy xem phần Sử dụng OAuth2 để truy cập API quản lý.

Bằng cách sử dụng thông tin xác thực của Apigee Edge, bạn có thể có được quyền truy cập OAuth 2.0 và mã làm mới để truy cập vào các tài nguyên của 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 bài viết Sử dụng get_token.

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

    Lần đầu tiên bạn nhập lệnh hoặc nếu mã 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 sáu chữ số. Nhập từng giá trị khi được nhắc. Nếu chưa bật tính năng xác thực hai yếu tố, bạn chỉ cần nhấn Enter khi được nhắc.

  3. Sao chép mã thông báo OAuth 2.0 rồi 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 giám sát API, hãy chuyển mã truy cập OAuth 2.0 vào tiêu đề HTTP bằng cách sử dụng tiêu đề Authorize (Uỷ quyền). Ví dụ:


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