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