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.
Chuyển đến tài liệu về Apigee X. thông tin

Đường dẫn cơ sở nền tảng API: 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:
application/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:
  • Tham số URI không bắt buộc giúp 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 mà sẽ tổng hợp trước một nhóm chỉ số dựa trên các phương diện đó. Nếu bạn không xác định phương diện nào (tức là nếu tham số URI trống), thì hệ thống sẽ tạo báo cáo cho mọi 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 các chỉ số, phạm vi thời gian, khoảng thời gian và các khía cạnh lọc/xem chi tiết của báo cáo.

dimension_name: Tham số URI xác định thực thể cần truy xuất các chỉ số của Nền tảng API. Apigee xác định một tập hợp các 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: 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 ứng dụng của nhà phát triển gửi yêu cầu đến API của bạn
  • /stats/client_ip: Địa chỉ IP của những ứng dụng gửi yêu cầu đến API trên Nền tảng API
  • /stats/developer_email: Địa chỉ email của 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 của nhà phát triển gửi yêu cầu đến API của bạn
  • /stats/devs:Mã nhận dạng nhà phát triển duy nhất do Edge tạo đã đă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 của ứng dụng
Lọc

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

Biểu tượng Hoạt động
in để đư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
Nội dung mô tả Lọc cấu trúc truy vấn
Số liệu thống kê về các proxy API có tên 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ê không có lỗi filter=(iserror eq 0)
Số liệu thống kê trong đó 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 Nội dung mô tả Mặc định Bắt buộc?
chọn Chỉ định chỉ số cần tổng hợp cho báo cáo. Các chỉ số được hỗ trợ bao gồm message_count, error_count, total_Response_time, max_Response_time, min_ response_time, data_ phối_size, end_point_Response_time Không áp dụng Có
timeRange Thời gian bắt đầu và kết thúc cho 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. Phạm vi 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ó
sắp xếp Khi chỉ định hai giá trị chọn lọc trở lên, bạn có thể dùng thuộc tính "sortby" để chỉ định giá trị được 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_Trao_đổi_kích thước, 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
đỉnh Lấy kết quả "k 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 Bật xem chi tiết 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 nhập mà API trả về Không áp dụng Không
bù trừ Sử dụng độ lệch có giới hạn để cho phép phân trang kết quả. Ví dụ: để hiển thị kết quả 11–20, hãy đặt giới hạn là "10" và độ lệch là "10". Không áp dụng Không
Phản hồ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" : {
    }
}
Phần tử tải trọng phản hồi:
Tên Nội dung 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 thu thập số liệu thống kê (hỗ trợ ký tự đại diện * để thu thập số liệu thống kê trên nhiều môi trường)
metrics Các giá trị được trả về cho phương diện được chỉ định
phương diện Phương diện được xác định để đo lường: trong ví dụ này là api_name.
metrics Các chỉ số trong báo cáo