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ở của 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ố của một phương diện

Động từ: TẢI
Xác thực: Xác thực cơ bản
Loại nội dung đa phương tiện:
ứng dụng/json
Tổng quan: Báo cáo được tạo bằng cách sử dụng yêu cầu GET trên API /stats tài nguyên, đi kèm với:
  • 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ủa các phương diện, chẳng hạn như tổng hợp trước một tập hợp các chỉ số dựa trên các phương diện đó. Nếu không có phương diện nào là đã xác định (tức là nếu tham số URI trống), thì báo cáo sẽ được tạo cho tất cả API có trong môi trường xác định.
  • 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/xem chi tiết của báo cáo.

dimension_name: Tham số URI xác định thực thể mà API Chỉ số nền tảng cần được truy xuất. Apigee xác định một tập hợp các phương diện có thể dùng trong . 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 ứ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 các ứng dụng gửi yêu cầu đến API trên API Nền tảng
  • /stats/developer_email: Địa chỉ email của nhà phát triển đã đăng ký trong trên Nền tảng API
  • /stats/developer_app: Tên ứng dụng của nhà phát triển gửi yêu cầu API của bạn
  • /stats/devs:Mã nhà phát triển duy nhất do Edge tạo đã đăng ký trong một trên Nền tảng API
  • /stats/access_token: Mã truy cập OAuth của người dùng cuối trong ứ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
Mô tả Lọc cấu trúc truy vấn
Thống kê cho các proxy API được đặt tên là api1 hoặc api2 filter=(apiproxy in 'api1','api2')
Số liệu thống kê cho tất 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ê 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 (proxy API) tên 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ố cần tổng hợp cho báo cáo. Sau đây là các chỉ số được hỗ trợ: số lượng tin nhắn, 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 trong 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 theo Khi hai hoặc nhiều giá trị chọn được chỉ định, "sortby" có thể được sử dụng để 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 Phạm vi sắp xếp được hỗ trợ là DESC hoặc ASC Không áp dụng Không
đỉnh Chọn "k hàng đầu" kết quả từ các 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 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ố mục nhập được API trả về Không áp dụng Không
bù trừ 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 kết quả 11 – 20, đặt giới hạn thành "10" và bù trừ thành "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" : {
    }
}
Các thành phần tải trọng của câu trả lờ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 để đo lường: trong ví dụ này là api_name.
chỉ số Các chỉ số cho báo cáo