คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
เส้นทางฐานของ API แพลตฟอร์ม:
https://api.enterprise.apigee.com/v1/o/{org_name}
เส้นทางทรัพยากร API: /environments/{env_name}/stats/{dimension_name}
คำอธิบาย: ใช้เมธอด GET เพื่อดึงข้อมูลเมตริกสำหรับมิติข้อมูล
| คำกริยา: | GET |
| การตรวจสอบสิทธิ์: | การตรวจสอบสิทธิ์แบบพื้นฐาน |
| ประเภทสื่อ: |
application/json
|
ภาพรวม: ระบบจะสร้างรายงานโดยใช้คำขอ GET ในทรัพยากร API
/stats API
พร้อมกับข้อมูลต่อไปนี้
- พารามิเตอร์ URI ที่ไม่บังคับซึ่งกำหนดมิติข้อมูลสำหรับรายงาน Apigee กำหนดมิติข้อมูลชุดหนึ่ง และรวมเมตริกชุดหนึ่งกับมิติข้อมูลเหล่านั้นไว้ล่วงหน้า หากไม่ได้กำหนดมิติข้อมูล (เช่น หากพารามิเตอร์ URI ว่างเปล่า) ระบบจะสร้างรายงานสำหรับ API ทั้งหมด ที่อยู่ในสภาพแวดล้อมที่ระบุ
- ชุดพารามิเตอร์การค้นหาที่กำหนดเมตริก ช่วงเวลา ช่วงเวลา และ ลักษณะตัวกรอง/การเจาะลึกของรายงาน
dimension_name: พารามิเตอร์ URI ที่กำหนดเอนทิตีที่ควรดึงข้อมูลเมตริกของ API
แพลตฟอร์ม Apigee กำหนดมิติข้อมูลชุดหนึ่งที่ใช้ใน
รายงานได้ มิติข้อมูลที่รองรับ ได้แก่
/stats/apis: พร็อกซี API ในองค์กรบน API แพลตฟอร์ม/stats/apiproducts: ผลิตภัณฑ์ API ที่กำหนดไว้ในองค์กร/stats/apps: ชื่อแอปของนักพัฒนาแอปที่ส่งคำขอไปยัง API ของคุณ/stats/client_ip: ที่อยู่ IP ของแอปที่ส่งคำขอไปยัง API บน API แพลตฟอร์ม/stats/developer_email: อีเมลของนักพัฒนาแอปที่ลงทะเบียนใน องค์กรบน API แพลตฟอร์ม/stats/developer_app: ชื่อแอปของนักพัฒนาแอปที่ส่งคำขอไปยัง API ของคุณ/stats/devs:รหัสนักพัฒนาแอปที่ไม่ซ้ำกันซึ่ง Edge สร้างขึ้นและลงทะเบียนใน องค์กรบน API แพลตฟอร์ม/stats/access_token: โทเค็นเพื่อการเข้าถึง OAuth ของผู้ใช้ปลายทางของแอป
คุณสามารถใช้ตัวกรองกับทรัพยากรที่กำหนดเองได้ ทรัพยากรที่กำหนดเอง ได้แก่
| สัญลักษณ์ | การดำเนินการ |
|---|---|
in |
สำหรับการรวมรายการ |
notin |
สำหรับการยกเว้นรายการ |
eq |
= |
ne |
!= หรือ |
gt |
> |
lt |
|
ge |
>= |
le |
| คำอธิบาย | โครงสร้างคำค้นหาตัวกรอง |
|---|---|
| สถิติสำหรับพร็อกซี API ที่ชื่อ api1 หรือ api2 | filter=(apiproxy in 'api1','api2') |
| สถิติสำหรับพร็อกซี API ทั้งหมด ยกเว้น api1 และ api2 | filter=(apiproxy notin 'ap1','api2') |
| สถิติที่ไม่มีข้อผิดพลาด | filter=(iserror eq 0) |
| สถิติที่ไม่มีข้อความแสดงข้อผิดพลาด หรือชื่อพร็อกซี API คือ api1 หรือ api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| สถิติที่ (โค้ดตอบกลับคือ 201 หรือ 301) และ (มีข้อผิดพลาด) หรือ (ชื่อพร็อกซี API คือ api1 หรือ api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
ตัวอย่างคำขอ:
$ 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
| ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
|---|---|---|---|
| เลือก | กำหนดเมตริกที่จะรวมสำหรับรายงาน เมตริกที่รองรับ ได้แก่ message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | ไม่มี | ใช่ |
| timeRange | เวลาเริ่มต้นและเวลาสิ้นสุดของช่วงเวลาที่ต้องการ รูปแบบวันที่คือ MM/DD/YYYY HH:MM เช่น 1/1/2013%2000:00~1/2/2013%2000:00 ช่วงเวลาสูงสุดคือ 6 เดือน | ไม่มี | ใช่ |
| timeUnit | second, minute, hour, day, week, month, quarter, year, decade, century, millennium | ไม่มี | ใช่ |
| sortby | เมื่อระบุค่า "เลือก" ตั้งแต่ 2 ค่าขึ้นไป คุณสามารถใช้ "sortby" เพื่อระบุค่า "เลือก" ที่ใช้ในการจัดเรียงผลลัพธ์ ได้แก่ message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | ไม่มี | ไม่ |
| จัดเรียง | ขอบเขตการจัดเรียงที่รองรับคือ DESC หรือ ASC | ไม่มี | ไม่ |
| topk | ใช้ผลลัพธ์ "k อันดับแรก" จากผลลัพธ์ เช่น หากต้องการแสดงผลลัพธ์ 5 รายการแรก ให้ใช้ "topk=5" | ไม่มี | ไม่ |
| ตัวกรอง | เปิดใช้การเจาะลึกในค่ามิติข้อมูลที่เฉพาะเจาะจง | ไม่มี | ไม่ |
| ขีดจำกัด | กำหนดขีดจำกัดสำหรับจำนวนรายการที่ API แสดงผล | ไม่มี | ไม่ |
| หักลบ | ใช้ออฟเซ็ตกับขีดจำกัดเพื่อเปิดใช้การแบ่งหน้าของผลลัพธ์ เช่น หากต้องการแสดงผลลัพธ์ 11-20 ให้ตั้งค่าขีดจำกัดเป็น '10' และออฟเซ็ตเป็น '10' | ไม่มี | ไม่ |
{
"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" : {
}
}| ชื่อ | คำอธิบาย |
|---|---|
| ข้อมูลเมตา | ข้อมูลเมตาที่เชื่อมโยงกับรายงาน |
| สภาพแวดล้อม | สภาพแวดล้อมในองค์กรที่รวบรวมสถิติ (รองรับเครื่องหมายดอกจัน * สำหรับการรวบรวมสถิติข้ามสภาพแวดล้อม) |
| เมตริก | ค่าที่แสดงผลสำหรับมิติข้อมูลที่ระบุ |
| มิติข้อมูล | มิติข้อมูลที่กำหนดไว้สำหรับการวัด ซึ่งในตัวอย่างนี้คือ api_name |
| เมตริก | เมตริกสำหรับรายงาน |