ดูบันทึกโดยใช้ API

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล

ดาวน์โหลดบันทึกการตรวจสอบ API เพื่อดูข้อมูลดิบที่ใช้ในการคำนวณเมตริกที่แสดงในหน้าแดชบอร์ดการตรวจสอบ API คุณสามารถดาวน์โหลดบันทึกสำหรับช่วงเวลาที่กำหนดเอง พร็อกซีเฉพาะ รหัสสถานะที่ระบุ และตัวแปรอื่นๆ อีกมากมาย

หมายเหตุ: โดยค่าเริ่มต้น การเรียก Logs API จะแสดงผลลัพธ์ที่มีรหัสสถานะ 4xx และ 5xx เท่านั้น แต่จะไม่แสดงผลลัพธ์ด้วยรหัส 2xx การทำเช่นนี้เพื่อจำกัดจำนวนผลลัพธ์ เนื่องจากผลลัพธ์ส่วนใหญ่มีรหัสสถานะ 2xx หากต้องการดูผลลัพธ์ที่มีรหัสสถานะ 2xx ให้เพิ่ม status=2xx ในคำขอ ตัวอย่างเช่น https://apimonitoring.enterprise.apigee.com/logs?status=2xx

ส่วนต่อไปนี้อธิบายวิธีจัดการบันทึกโดยใช้ API

• ดาวน์โหลดบันทึกสำหรับองค์กรและสภาพแวดล้อมที่ต้องการ
• แสดงรายการพร็อกซีที่เชื่อมโยงกับองค์กรและสภาพแวดล้อม

โปรดดู Logs API สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ Logging API

ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างเหล่านี้ได้ที่ใช้ cURL

ดาวน์โหลดบันทึกสำหรับองค์กรและสภาพแวดล้อม

ดาวน์โหลดบันทึกสำหรับองค์กรและสภาพแวดล้อมที่ต้องการโดยใช้ Logs API ดังนี้

https://apimonitoring.enterprise.apigee.com/logs

คุณต้องส่งชื่อองค์กรและสภาพแวดล้อมโดยใช้พารามิเตอร์การค้นหา org และ env

โดยค่าเริ่มต้น API จะแสดงรายการบันทึก 10 รายการล่าสุดสำหรับ 1 ชั่วโมงก่อนหน้า เช่น

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในรับโทเค็นเพื่อการเข้าถึง OAuth 2.0

การตอบสนองคืออาร์เรย์ของรายการบันทึกในแบบฟอร์ม:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

ใช้พารามิเตอร์การค้นหา from และ to เพื่อระบุช่วงเวลาในรูปแบบ ISO รูปแบบวันที่อาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

• yyyy-mm-ddThh:mm:ssZ
• yyyy-mm-ddThh:mm:ss+00:00

เช่น

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

API มีพารามิเตอร์การค้นหาที่ไม่บังคับหลายรายการ ตัวอย่างเช่น หากต้องการดูบันทึกสำหรับพร็อกซีชื่อ myAPI ที่สร้างการตอบกลับ HTTP 404 ให้ทำดังนี้

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

หากต้องการแสดงรายการบันทึกมากกว่า 10 รายการ ให้ตั้งค่าพารามิเตอร์การค้นหา limit คุณสามารถตั้งค่า ค่าสูงสุดคือ 1,000 ดังนี้

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

โปรดดูตัวเลือกเพิ่มเติมที่ Logs API

แสดงรายการพร็อกซีที่เชื่อมโยงกับโฮสต์เสมือนและเส้นทางฐาน

โฮสต์เสมือนบนเราเตอร์ Edge ช่วยให้คุณระบุชื่อโดเมน โปรโตคอล เช่น HTTP/HTTPS และหมายเลขพอร์ตได้ ตัวอย่างเช่น คุณกำหนดโฮสต์เสมือนบนเราเตอร์ Edge ด้วยการตั้งค่าต่อไปนี้

• ชื่อแทนโฮสต์ = apis.acme.com
• พอร์ต = 443
• ใช้งาน TLS อยู่

จากการตั้งค่าเหล่านี้ คำขอที่ส่งไปยังพร็อกซี API ที่เชื่อมโยงกับโฮสต์เสมือนนี้จะใช้แบบฟอร์มต่อไปนี้

https://apis.acme.com/proxy-base-path/resource-path

โดยที่

• ระบบจะกำหนด proxy-base-path ไว้เมื่อคุณสร้างพร็อกซี API และจะไม่ซ้ำกันสำหรับพร็อกซี API แต่ละรายการ
• resource-path คือเส้นทางไปยังทรัพยากรที่เข้าถึงได้ผ่านพร็อกซี API

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับโฮสต์เสมือนที่หัวข้อเกี่ยวกับโฮสต์เสมือน

ดาวน์โหลดรายการพร็อกซี API ที่เชื่อมโยงกับโฮสต์เสมือนและเส้นทางฐานที่เฉพาะเจาะจงโดยการส่งคำขอ GET ไปยังทรัพยากร Logs API ต่อไปนี้

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

คุณต้องส่งชื่อองค์กรและสภาพแวดล้อมโดยใช้พารามิเตอร์การค้นหา org และ env รวมถึง URI ที่เชื่อมโยงกับโฮสต์เสมือนและเส้นทางพื้นฐาน

ตัวอย่างเช่น การเรียก API ต่อไปนี้จะแสดงผลพร็อกซีที่เชื่อมโยงกับโฮสต์เสมือน http://apis.acme.com และเส้นทางฐาน /v1/perf

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" 

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในรับโทเค็นเพื่อการเข้าถึง OAuth 2.0

โปรดดูตัวเลือกเพิ่มเติมที่ Logs API