คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เส้นทางฐานของแพลตฟอร์ม API:
https://api.enterprise.apigee.com/v1/o/{org_name}
เส้นทางทรัพยากร API: /environments/{env_name}/stats/{dimension_name}
คำอธิบาย: ใช้เมธอด GET เพื่อเรียกข้อมูลเมตริกของมิติข้อมูล
| คำกริยา: | GET |
| การตรวจสอบสิทธิ์: | การตรวจสอบสิทธิ์พื้นฐาน |
| ประเภทสื่อ: |
application/json
|
ภาพรวม: ระบบจะสร้างรายงานโดยใช้คำขอ GET บนทรัพยากร API
/stats พร้อมด้วยข้อมูลต่อไปนี้
- พารามิเตอร์ 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 | วินาที, นาที, ชั่วโมง, วัน, สัปดาห์, เดือน, ไตรมาส, ปี, ทศวรรษ, ศตวรรษ, สหัสวรรษ | ไม่มีข้อมูล | ใช่ |
| จัดเรียง | เมื่อระบุค่าที่เลือกอย่างน้อย 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 | เช่น ใช้ผลลัพธ์ "topk=5" เป็น "topk=5" เพื่อแสดงผลการค้นหา 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" : {
}
}
องค์ประกอบเพย์โหลดการตอบกลับ:
| ชื่อ | คำอธิบาย |
|---|---|
| ข้อมูลเมตา | ข้อมูลเมตาที่เชื่อมโยงกับรายงาน |
| สภาพแวดล้อม | สภาพแวดล้อมในองค์กรที่มีการรวบรวมสถิติ (รองรับไวลด์การ์ด * สำหรับการรวบรวมสถิติข้ามสภาพแวดล้อม) |
| metrics | ค่าที่แสดงผลสำหรับมิติข้อมูลที่ระบุ |
| มิติข้อมูล | มิติข้อมูลที่กำหนดไว้สำหรับการวัด ในตัวอย่างนี้คือ api_name |
| metrics | เมตริกสำหรับรายงาน |