Truy xuất và lọc các chỉ số cho một phương diện từ các dịch vụ Apigee Analytics

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

Đường dẫn cơ sở của API Platform: https://api.enterprise.apigee.com/v1/o/{org_name}

Đường dẫn tài nguyên API: /environments/{env_name}/stats/{dimension_name}

Nội dung mô tả: Sử dụng phương thức GET để truy xuất các chỉ số cho một phương diện

Động từ: GET
Xác thực: Xác thực cơ bản
Loại nội dung nghe nhìn:
ứng dụng/json
Tổng quan: Báo cáo được tạo bằng yêu cầu GET trên tài nguyên API /stats, kèm theo:
  • Một tham số URI không bắt buộc xác định phương diện cho báo cáo. Apigee xác định một tập hợp các phương diện và tổng hợp trước một tập hợp các chỉ số dựa trên những phương diện đó. Nếu không có phương diện nào được xác định (tức là nếu tham số URI trống), thì một báo cáo sẽ được tạo cho tất cả các API có trong môi trường được chỉ định.
  • Một tập hợp các tham số truy vấn xác định chỉ số, phạm vi thời gian, khoảng thời gian và các khía cạnh lọc/đi sâu của báo cáo.

dimension_name: Một tham số URI xác định thực thể mà bạn nên truy xuất các chỉ số Nền tảng API. Apigee xác định một nhóm phương diện có thể dùng trong báo cáo. Các phương diện được hỗ trợ bao gồm:

  • /stats/apis: Các proxy API trong một tổ chức trên Nền tảng API
  • /stats/apiproducts: Các sản phẩm API được xác định trong một tổ chức
  • /stats/apps: Tên của ứng dụng nhà phát triển đưa ra yêu cầu đến API của bạn
  • /stats/client_ip: Địa chỉ IP của các ứng dụng đưa ra yêu cầu đến API trên Nền tảng API
  • /stats/developer_email: Địa chỉ email của một nhà phát triển đã đăng ký trong một tổ chức trên Nền tảng API
  • /stats/developer_app: Tên của ứng dụng nhà phát triển đưa ra yêu cầu đến API của bạn
  • /stats/devs:Mã nhận dạng duy nhất do Edge tạo cho nhà phát triển, được đăng ký trong một tổ chức trên Nền tảng API
  • /stats/access_token: Mã truy cập OAuth của người dùng cuối ứng dụng
Lọc

Bạn có thể áp dụng bộ lọc cho các tài nguyên tuỳ chỉnh. Tài nguyên tuỳ chỉnh là:

Biểu tượng Hoạt động
in để được đưa vào danh sách
notin để loại trừ danh sách
eq =
ne != hoặc
gt >
lt
ge >=
le
Bộ lọc mẫu
Mô tả Cấu trúc truy vấn bộ lọc
Số liệu thống kê cho các proxy API có tên là api1 hoặc api2 filter=(apiproxy in 'api1','api2')
Số liệu thống kê cho tất cả các proxy API, ngoại trừ api1 và api2 filter=(apiproxy notin 'ap1','api2')
Số liệu thống kê khi không có lỗi filter=(iserror eq 0)
Số liệu thống kê không có thông báo lỗi hoặc tên proxy API là api1 hoặc api2 filter=(iserror eq 1) or (apiproxy in 'api1','api2')
Số liệu thống kê trong đó (mã phản hồi là 201 hoặc 301) và (có lỗi) hoặc (tên proxy API là api1 hoặc api2) filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

Yêu cầu mẫu:

$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
Tham số truy vấn:
Tên Mô tả Mặc định Bắt buộc?
chọn Chỉ định chỉ số sẽ được tổng hợp cho báo cáo. Các chỉ số được hỗ trợ là message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time Không áp dụng Có
timeRange Thời gian bắt đầu và kết thúc của khoảng thời gian mong muốn. Định dạng ngày là MM/DD/YYYY HH:MM. Ví dụ: 1/1/2013%2000:00~1/2/2013%2000:00. Khoảng thời gian tối đa là 6 tháng Không áp dụng Có
timeUnit giây, phút, giờ, ngày, tuần, tháng, quý, năm, thập kỷ, thế kỷ, thiên niên kỷ Không áp dụng Có
sortby Khi bạn chỉ định từ 2 giá trị chọn trở lên, bạn có thể dùng "sortby" để chỉ định lựa chọn dùng để sắp xếp kết quả: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time Không áp dụng Không
sắp xếp Các phạm vi sắp xếp được hỗ trợ là DESC hoặc ASC Không áp dụng Không
topk Lấy "kết quả hàng đầu" từ kết quả, ví dụ: để trả về 5 kết quả hàng đầu "topk=5". Không áp dụng Không
filter Cho phép đi sâu vào các giá trị phương diện cụ thể Không áp dụng Không
giới hạn Đặt giới hạn cho số lượng mục mà API trả về Không áp dụng Không
độ lệch Sử dụng độ lệch có giới hạn để bật tính năng phân trang kết quả. Ví dụ: để hiển thị kết quả từ 11 đến 20, hãy đặt giới hạn thành "10" và độ lệch thành "10". Không áp dụng Không
Câu trả lời mẫu: 
{
  "environments" : [ {
        "dimensions" : [ {
          "metrics" : [ 
                 {
                "name" : "message_count",
                "values" : [ {
                   "timestamp" : 1335241800000,
                   "value" : "1.0"
                 } ]
              } ,
                 {
                 "name" : "error_count",
                 "values" : [ {
                    "timestamp" : 1335241800000,
                    "value" : "0.0"
                   } ]
            } 
              ],
        
               "name" : "api1"
        }, 
            {
          "metrics" : [ 
               {
              "name" : "message_count",
              "values" : [ {
                     "timestamp" : 1335241800000,
                     "value" : "1.0"
                  } ]
             },
                {
                "name" : "error_count",
                "values" : [ {
                      "timestamp" : 1335241800000,
                      "value" : "0.0"
                } ]
            } 
             ],
        
             "name" : "api2"
        } 
          ],
        
         "name" : "test"
      } 
    ],
   "metaData" : {
    }
}
Các phần tử tải trọng phản hồi:
Tên Mô tả
siêu dữ liệu Siêu dữ liệu liên kết với báo cáo
môi trường Các môi trường trong tổ chức nơi số liệu thống kê được thu thập (hỗ trợ ký tự đại diện * để thu thập số liệu thống kê trên nhiều môi trường)
chỉ số Các giá trị được trả về cho phương diện đã chỉ định
phương diện Phương diện được xác định cho hoạt động đo lường: trong ví dụ này là api_name.
chỉ số Các chỉ số cho báo cáo