ส่งออกข้อมูลจาก Analytics

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

ตั้งค่าสิทธิ์สำหรับตัวแทนบริการที่ได้รับมอบหมาย

หากต้องการตั้งค่าสิทธิ์สำหรับตัวแทนบริการที่ได้รับมอบหมาย ให้ทำตามขั้นตอนต่อไปนี้เพื่อเตรียมพร้อมสำหรับการเปลี่ยนแปลงที่อธิบายไว้ข้างต้น

1. ค้นหาชื่อของ Agent บริการ Google Cloud โดยป้อนคำสั่งต่อไปนี้

   curl -X GET \
     "https://api.enterprise.apigee.com/v1/organizations/ORG" \
     -u email:password \
     | jq -r '.properties.property[] | select(.name=="serviceAgent.analytics") | .value'

   เดิมคือ ORG เป็นองค์กรของคุณ ซึ่งจะแสดงชื่อและค่าของ Agent บริการดังที่แสดงด้านล่าง

   "property" : [
     {
      "name" : "serviceAgent.analytics",
      "value" : "service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com"
      },

2. เปิดแดชบอร์ด IAM ในคอนโซล Google Cloud
3. เลือกโปรเจ็กต์ Google Cloud
4. คลิกเพิ่มที่ด้านบนของแผง IAM
5. ในช่องผู้ใช้หลักรายใหม่ ให้ป้อน Agent บริการ value ที่แสดงผลในขั้นตอนที่ 1 เช่น value ที่แสดงในขั้นตอนที่ 1 คือ service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com
6. คลิกปุ่ม +เพิ่มบทบาทอื่น แล้วเพิ่มบทบาทต่อไปนี้
   • ผู้ใช้ BigQuery
   • ผู้ดูแลระบบพื้นที่เก็บข้อมูล
7. คลิกบันทึก

ข้อมูล Analytics ของ Apigee

รูปแบบข้อมูลส่งออก

ส่งออกข้อมูลวิเคราะห์เป็นรูปแบบใดรูปแบบหนึ่งต่อไปนี้

• ค่าที่คั่นด้วยคอมมา (CSV)

  ตัวคั่นเริ่มต้นคือเครื่องหมายคอมมา (,) อักขระของตัวคั่นที่รองรับ ได้แก่ เครื่องหมายคอมมา (,), ไปป์ (|) และแท็บ (\t) กำหนดค่าโดยใช้พร็อพเพอร์ตี้ csvDelimiter ดังที่อธิบายใน ส่งออกการอ้างอิงพร็อพเพอร์ตี้คำขอ

• JSON (คั่นด้วยการขึ้นบรรทัดใหม่)

  อนุญาตให้ใช้อักขระบรรทัดใหม่เป็นตัวคั่นได้

ข้อมูลที่ส่งออกประกอบด้วยมิติข้อมูลและเมตริกข้อมูลวิเคราะห์ทั้งหมดที่สร้างขึ้นใน Edge รวมถึงข้อมูลวิเคราะห์ที่กำหนดเองใดๆ ที่คุณเพิ่ม หากต้องการคำอธิบายของข้อมูลที่ส่งออก โปรดดูข้อมูลอ้างอิงเมตริก มิติข้อมูล และตัวกรองของ Analytics

คุณส่งออกข้อมูลวิเคราะห์ไปยังที่เก็บข้อมูลต่อไปนี้ได้

• Google Cloud Storage
• Google BigQuery

ภาพรวมของกระบวนการส่งออก

ขั้นตอนต่อไปนี้จะสรุปกระบวนการที่ใช้ในการส่งออกข้อมูล Analytics

1. กำหนดค่าที่เก็บข้อมูลของคุณ (Cloud Storage หรือ BigQuery) สำหรับการส่งออกข้อมูล คุณต้องตรวจสอบว่าที่เก็บข้อมูลของคุณได้รับการกำหนดค่าอย่างถูกต้อง และบัญชีบริการที่ใช้เขียนข้อมูลลงในที่เก็บข้อมูลมีสิทธิ์ที่ถูกต้อง

2. สร้างพื้นที่เก็บข้อมูลที่กำหนดพร็อพเพอร์ตี้ของที่เก็บข้อมูล (Cloud Storage หรือ BigQuery) ที่คุณใช้ส่งออกข้อมูล รวมถึงข้อมูลเข้าสู่ระบบที่ใช้ในการเข้าถึงที่เก็บข้อมูล

   เมื่อสร้างพื้นที่เก็บข้อมูล คุณจะอัปโหลดข้อมูลเข้าสู่ระบบของที่เก็บข้อมูลไปยังห้องนิรภัยข้อมูลเข้าสู่ระบบ Edge เพื่อจัดเก็บข้อมูลดังกล่าวอย่างปลอดภัย จากนั้นกลไกการส่งออกข้อมูลจะใช้ข้อมูลเข้าสู่ระบบเหล่านั้นในการเขียนข้อมูลลงในที่เก็บข้อมูลของคุณ

3. ใช้ API การส่งออกข้อมูลเพื่อเริ่มการส่งออกข้อมูล การส่งออกข้อมูลจะทำงานแบบไม่พร้อมกันในเบื้องหลัง

4. ใช้ API การส่งออกข้อมูลเพื่อพิจารณาว่าการส่งออกจะเสร็จสมบูรณ์เมื่อใด

5. เมื่อการส่งออกเสร็จสิ้นแล้ว ให้เข้าถึงข้อมูลที่ส่งออกในที่เก็บข้อมูลของคุณ

ส่วนต่อไปนี้จะอธิบายขั้นตอนเหล่านี้โดยละเอียด

กำหนดค่าที่เก็บข้อมูลของคุณ

กลไกการส่งออกข้อมูลวิเคราะห์จะเขียนข้อมูลไปยัง Cloud Storage หรือ BigQuery หากต้องการให้การเขียนดังกล่าวเกิดขึ้น คุณจะต้อง

• สร้างบัญชีบริการ Google Cloud Platform
• กำหนดบทบาทของบัญชีบริการเพื่อให้เข้าถึง Cloud Storage หรือ BigQuery ได้

สร้างบัญชีบริการสำหรับ Cloud Storage หรือ BigQuery

บัญชีบริการคือบัญชี Google ประเภทหนึ่งที่เป็นของแอปพลิเคชันของคุณ ไม่ใช่ของผู้ใช้แต่ละราย จากนั้นแอปพลิเคชันจะใช้บัญชีบริการเพื่อเข้าถึงบริการ

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

บัญชีบริการที่เชื่อมโยงกับคีย์ต้องเป็นเจ้าของโปรเจ็กต์ Google Cloud Platform และมีสิทธิ์เขียนที่เก็บข้อมูล Google Cloud Storage หากต้องการสร้างคีย์บริการและดาวน์โหลดเพย์โหลดที่จำเป็น โปรดดูการสร้างและจัดการคีย์บัญชีบริการในเอกสารประกอบของ Google Cloud Platform

ตัวอย่างเช่น เมื่อดาวน์โหลดคีย์ครั้งแรก คีย์จะมีการจัดรูปแบบเป็นออบเจ็กต์ JSON ดังนี้

{ 
  "type": "service_account", 
  "project_id": "myProject", 
  "private_key_id": "12312312", 
  "private_key": "-----BEGIN PRIVATE KEY-----\n...", 
  "client_email": "client_email@developer.gserviceaccount.com", 
  "client_id": "879876769876", 
  "auth_uri": "https://accounts.google.com/organizations/oauth2/auth", 
  "token_uri": "https://oauth2.googleapis.com/token", 
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2", 
  "client_x509_cert_url": "https://www.googleapis.com" 
}

กำหนดค่า Google Cloud Storage

ก่อนที่จะส่งออกข้อมูลไปยัง Google Cloud Storage ได้ ให้ทำดังนี้

• ตรวจสอบว่าได้เปิดใช้ API ของ BigQuery และ Cloud Resource Manager ในโปรเจ็กต์ Google Cloud Platform แล้ว โปรดดูคำแนะนำที่การเปิดใช้ API Apigee คือ BigQuery API เพื่อใช้ประโยชน์จากฟีเจอร์การส่งออกของ BigQuery เมื่อส่งออกไปยัง Cloud Storage และ API ของ Cloud Resource Manager เพื่อตรวจสอบสิทธิ์ก่อนการส่งออกแต่ละครั้ง

• ตรวจสอบว่าบัญชีบริการมีบทบาทต่อไปนี้

  • ผู้ใช้ของงาน BigQuery
  • ผู้สร้างออบเจ็กต์พื้นที่เก็บข้อมูล
  • ผู้ดูแลระบบพื้นที่เก็บข้อมูล (จำเป็นสำหรับการทดสอบพื้นที่เก็บข้อมูลตามที่อธิบายไว้ในทดสอบการกำหนดค่าพื้นที่เก็บข้อมูลเท่านั้น หากบทบาทนี้กว้างเกินไป คุณสามารถเพิ่มสิทธิ์ storage.buckets.get ให้กับบทบาทที่มีอยู่แทนได้)

  หรือหากต้องการแก้ไขบทบาทที่มีอยู่หรือสร้างบทบาทที่กำหนดเอง ให้เพิ่มสิทธิ์ต่อไปนี้ให้กับบทบาท

  • bigquery.jobs.create
  • storage.objects.create
  • storage.buckets.get (จำเป็นเฉพาะสำหรับการทดสอบพื้นที่เก็บข้อมูลตามที่อธิบายไว้ในทดสอบการกำหนดค่าพื้นที่เก็บข้อมูล)

กำหนดค่า Google BigQuery

สิ่งที่ควรทราบก่อนส่งออกข้อมูลไปยัง Google BigQuery

• ตรวจสอบว่าได้เปิดใช้ API ของ BigQuery และ Cloud Resource Manager ในโปรเจ็กต์ Google Cloud Platform แล้ว โปรดดูคำแนะนำที่การเปิดใช้ API Apigee จะใช้ Cloud Resource Manager API เพื่อตรวจสอบสิทธิ์ก่อนการส่งออกแต่ละครั้ง
• ตรวจสอบว่าได้เปิดใช้ BigQuery API ในโปรเจ็กต์ Google Cloud Platform แล้ว โปรดดูคำแนะนำที่การเปิดใช้และปิดใช้ API

• ตรวจสอบว่าบัญชีบริการมีบทบาทต่อไปนี้

  • ผู้ใช้ของงาน BigQuery
  • ผู้แก้ไขข้อมูล BigQuery

  หากคุณต้องการแก้ไขบทบาทที่มีอยู่หรือสร้างบทบาทที่กำหนดเอง ให้เพิ่มสิทธิ์ต่อไปนี้ให้กับบทบาท

  • bigquery.datasets.create
  • bigquery.datasets.get
  • bigquery.jobs.create
  • bigquery.tables.create
  • bigquery.tables.get
  • bigquery.tables.updateData

สร้างพื้นที่เก็บข้อมูล

พื้นที่เก็บข้อมูลจะกำหนดการเชื่อมต่อกับที่เก็บข้อมูลส่งออก (Cloud Storage, BigQuery) รวมถึงข้อมูลเข้าสู่ระบบที่ใช้ในการเข้าถึงที่เก็บข้อมูล

เกี่ยวกับห้องนิรภัยข้อมูลเข้าสู่ระบบ Edge

Edge ใช้ห้องนิรภัยข้อมูลเข้าสู่ระบบเพื่อจัดเก็บข้อมูลเข้าสู่ระบบที่ใช้เข้าถึงที่เก็บข้อมูลการส่งออกของคุณอย่างปลอดภัย หากต้องการให้บริการเข้าถึงข้อมูลเข้าสู่ระบบในห้องนิรภัยข้อมูลเข้าสู่ระบบ Edge คุณต้องกำหนดผู้บริโภคข้อมูลเข้าสู่ระบบ

เมื่อสร้างการจัดเก็บข้อมูลโดยใช้ Edge UI ดังที่อธิบายด้านล่าง Edge จะสร้างผู้บริโภคที่ใช้เข้าถึงข้อมูลเข้าสู่ระบบโดยอัตโนมัติ

ทดสอบการกำหนดค่าพื้นที่เก็บข้อมูล

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

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

หากการทดสอบสําเร็จ ให้สร้างพื้นที่เก็บข้อมูล หากทดสอบไม่สำเร็จ ให้แก้ไขข้อผิดพลาดแล้วทดสอบการกำหนดค่าอีกครั้ง คุณสร้างพื้นที่เก็บข้อมูลได้หลังจากการทดสอบเสร็จสมบูรณ์แล้วเท่านั้น

หากต้องการเปิดใช้ฟีเจอร์ทดสอบ คุณต้องทำดังนี้

• ตรวจสอบว่าเปิดใช้ Cloud Resource Manager API ในโปรเจ็กต์ Google Cloud Platform แล้ว โปรดดูคำแนะนำที่การเปิดใช้และปิดใช้ API

สร้างพื้นที่เก็บข้อมูล

วิธีสร้างพื้นที่เก็บข้อมูลใน UI

1. ลงชื่อเข้าสู่ระบบ https://apigee.com/edge ในฐานะผู้ดูแลระบบองค์กรและเลือกองค์กรของคุณ

   หมายเหตุ: คุณต้องเป็นผู้ดูแลระบบองค์กร Edge จึงจะสร้างพื้นที่เก็บข้อมูลได้

2. เลือกผู้ดูแลระบบ > Analytics Datastore จากแถบนำทางด้านซ้าย หน้า Analytics Datastore จะแสดงขึ้น

3. เลือกปุ่ม + เพิ่มพื้นที่เก็บข้อมูล ระบบจะแจ้งให้เลือกประเภทพื้นที่เก็บข้อมูลดังนี้

   

4. เลือกประเภทเป้าหมายส่งออกข้อมูล ดังนี้

   • Google Cloud Storage
   • Google BigQuery

   หน้าการกำหนดค่าจะปรากฏดังนี้

   

5. ป้อนชื่อพื้นที่เก็บข้อมูล

6. เลือกข้อมูลเข้าสู่ระบบที่ใช้เข้าถึงที่เก็บข้อมูล รายการแบบเลื่อนลงของข้อมูลเข้าสู่ระบบที่ใช้ได้จะปรากฏขึ้น

   ข้อมูลเข้าสู่ระบบใช้ได้กับที่เก็บข้อมูลประเภทหนึ่งๆ โดยเฉพาะ โปรดดูที่หัวข้อสร้างบัญชีบริการสำหรับ Cloud Storage หรือ BigQuery

   • หากคุณอัปโหลดข้อมูลเข้าสู่ระบบแล้ว ให้เลือกข้อมูลเข้าสู่ระบบจากรายการแบบเลื่อนลง ตรวจสอบว่าคุณเลือกข้อมูลเข้าสู่ระบบที่เหมาะกับประเภทที่เก็บข้อมูล

   • หากคุณจะเพิ่มข้อมูลเข้าสู่ระบบใหม่ลงในพื้นที่เก็บข้อมูล ให้เลือกเพิ่มใหม่ ป้อนข้อมูลต่อไปนี้ในกล่องโต้ตอบ

     1. ชื่อข้อมูลเข้าสู่ระบบ
     2. เนื้อหาข้อมูลเข้าสู่ระบบคือคีย์บัญชีบริการ JSON สำหรับที่เก็บข้อมูลของคุณโดยเฉพาะตามที่กำหนดโดยสร้างบัญชีบริการสำหรับ Cloud Storage หรือ BigQuery
     3. เลือกสร้าง

7. ป้อนพร็อพเพอร์ตี้เฉพาะของที่เก็บข้อมูลประเภทนั้นๆ ดังนี้

   • สำหรับ Google Cloud Storage

     พร็อพเพอร์ตี้	คำอธิบาย	จำเป็นหรือไม่
     รหัสโปรเจ็กต์	รหัสโปรเจ็กต์ Google Cloud Platform หากต้องการสร้างโปรเจ็กต์ Google Cloud Platform โปรดดูการสร้างและจัดการโปรเจ็กต์ในเอกสารประกอบของ Google Cloud Platform	ใช่
     ชื่อที่เก็บข้อมูล	ชื่อของที่เก็บข้อมูลใน Cloud Storage ที่คุณต้องการส่งออกข้อมูล Analytics คุณต้องมีที่เก็บข้อมูลนี้ก่อนจึงจะส่งออกข้อมูลได้ หากต้องการสร้างที่เก็บข้อมูล Cloud Storage โปรดดูการสร้างที่เก็บข้อมูลของพื้นที่เก็บข้อมูลในเอกสารของ Google Cloud Platform	ใช่
     เส้นทาง	ไดเรกทอรีสำหรับจัดเก็บข้อมูลการวิเคราะห์ในที่เก็บข้อมูล Cloud Storage	ใช่

   • สำหรับ BigQuery

     พร็อพเพอร์ตี้	คำอธิบาย	จำเป็นหรือไม่
     รหัสโปรเจ็กต์	รหัสโปรเจ็กต์ Google Cloud Platform หากต้องการสร้างโปรเจ็กต์ Google Cloud Platform โปรดดูการสร้างและจัดการโปรเจ็กต์ในเอกสารประกอบของ Google Cloud Platform	ใช่
     ชื่อชุดข้อมูล	ชื่อชุดข้อมูล BigQuery ที่คุณต้องการส่งออกข้อมูล Analytics ตรวจสอบว่าได้สร้างชุดข้อมูลแล้วก่อนที่จะขอการส่งออกข้อมูล หากต้องการสร้างชุดข้อมูล BigQuery โปรดดูการสร้างและการใช้ชุดข้อมูลในเอกสารของ Google Cloud Platform	ใช่
     คำนำหน้าตาราง	คำนำหน้าสำหรับชื่อตารางที่สร้างขึ้นสำหรับข้อมูลการวิเคราะห์ในชุดข้อมูล BigQuery	ใช่

8. เลือกทดสอบการเชื่อมต่อเพื่อให้แน่ใจว่าจะใช้ข้อมูลเข้าสู่ระบบเพื่อเข้าถึงที่เก็บข้อมูลได้

   หากการทดสอบสำเร็จ ให้บันทึกพื้นที่เก็บข้อมูล

   หากการทดสอบไม่สำเร็จ ให้แก้ไขปัญหาแล้วลองทดสอบอีกครั้ง เลื่อนเมาส์เหนือข้อความแสดงข้อผิดพลาดใน UI เพื่อแสดงข้อมูลเพิ่มเติมในเคล็ดลับเครื่องมือ

9. หลังจากการทดสอบการเชื่อมต่อผ่านแล้ว ให้บันทึกพื้นที่เก็บข้อมูล

แก้ไขพื้นที่เก็บข้อมูล

วิธีแก้ไขพื้นที่เก็บข้อมูล

1. ลงชื่อเข้าสู่ระบบ https://apigee.com/edge ในฐานะผู้ดูแลระบบองค์กรและเลือกองค์กรของคุณ

2. เลือกผู้ดูแลระบบ > Analytics Datastore จากแถบนำทางด้านซ้าย หน้า Analytics Datastore จะแสดงขึ้น

3. เลื่อนตัวชี้เมาส์ไปที่คอลัมน์แก้ไขของรายงานเพื่อแก้ไข ไอคอนแก้ไขและลบจะปรากฏขึ้น

4. แก้ไขหรือลบพื้นที่เก็บข้อมูล

5. หากคุณแก้ไขพื้นที่เก็บข้อมูล ให้เลือกทดสอบการเชื่อมต่อเพื่อให้แน่ใจว่าจะใช้ข้อมูลเข้าสู่ระบบเพื่อเข้าถึงพื้นที่เก็บข้อมูลได้

   หากการทดสอบประสบความสำเร็จ คุณจะดูข้อมูลตัวอย่างในที่เก็บข้อมูลได้

   หากการทดสอบไม่สำเร็จ ให้แก้ไขปัญหาแล้วลองทดสอบอีกครั้ง

6. หลังจากการทดสอบการเชื่อมต่อผ่านแล้ว ให้อัปเดตพื้นที่เก็บข้อมูล

ส่งออกข้อมูล Analytics

หากต้องการส่งออกข้อมูลวิเคราะห์ ให้ส่งคำขอ POST ไปยัง /analytics/exports API ส่งต่อข้อมูลต่อไปนี้ในเนื้อหาคำขอ

• ชื่อและคำอธิบายของคำขอส่งออก
• ช่วงวันที่ของข้อมูลที่ส่งออก (ค่ามีระยะเวลาได้ 1 วันเท่านั้น)
• รูปแบบของข้อมูลที่ส่งออก
• ชื่อพื้นที่เก็บข้อมูล
• มีการเปิดใช้การสร้างรายได้ในองค์กรหรือไม่

ตัวอย่างคำขอส่งออกมีดังนี้ สำหรับคำอธิบายที่สมบูรณ์ของพร็อพเพอร์ตี้เนื้อหาคำขอ โปรดดูส่งออกข้อมูลอ้างอิงพร็อพเพอร์ตี้คำขอ

การตอบกลับจาก POST จะอยู่ในรูปแบบต่อไปนี้

{
    "self": "/organizations/myorg/environments/test/analytics/exports/a7c2f0dd-1b53-4917-9c42-a211b60ce35b",
    "created": "2017-09-28T12:39:35Z",
    "state": "enqueued"
}

โปรดทราบว่าพร็อพเพอร์ตี้ state ในการตอบสนองตั้งค่าเป็น enqueued คำขอ POST จะทำงานแบบไม่พร้อมกัน ซึ่งหมายความว่าส่วนขยายจะทำงานต่อไปในพื้นหลังหลังจากที่คำขอแสดงผลการตอบกลับ ค่าที่เป็นไปได้สำหรับ state ได้แก่ enqueued, running, completed, failed

ใช้ URL ที่แสดงในพร็อพเพอร์ตี้ self เพื่อดูสถานะของคำขอส่งออกข้อมูลตามที่อธิบายไว้ในการดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์ เมื่อคำขอเสร็จสมบูรณ์ ค่าของพร็อพเพอร์ตี้ state ในการตอบกลับจะตั้งค่าเป็น completed จากนั้นคุณจะเข้าถึงข้อมูลวิเคราะห์ในพื้นที่เก็บข้อมูลได้

ตัวอย่างที่ 1: ส่งออกข้อมูลไปยัง Cloud Storage

คำขอต่อไปนี้ส่งออกชุดข้อมูลดิบทั้งหมดในช่วง 24 ชั่วโมงที่ผ่านมาจากสภาพแวดล้อม test ในองค์กร myorg ระบบจะส่งออกเนื้อหาไปยัง Cloud Storage ในรูปแบบ JSON ดังนี้

curl -X POST -H "Content-Type:application/json" \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }' \
  -u orgAdminEmail:password

ใช้ URI ที่ระบุโดยพร็อพเพอร์ตี้ self เพื่อตรวจสอบสถานะของงานตามที่อธิบายไว้ในการดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์

ตัวอย่างที่ 2: ส่งออกข้อมูลไปยัง BigQuery

คำขอต่อไปนี้ส่งออกไฟล์ CSV ที่คั่นด้วยคอมมาไปยัง BigQuery

curl -X POST -H "Content-Type:application/json"  \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export query results to BigQuery",
    "description": "One-time export to BigQuery",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "csv",
    "csvDelimiter": ",", 
    "datastoreName": "My BigQuery data repository"
  }' \
  -u orgAdminEmail:password

หมายเหตุ: ไฟล์ CSV ที่ส่งออกจะสร้างตาราง BigQuery โดยมีคำนำหน้าต่อไปนี้

<PREFIX>_<EXPORT_DATE>_api_<UUID>_from_<FROM_DATE>_to_<TO_DATE>

ใช้ URI ที่ระบุโดยพร็อพเพอร์ตี้ self เพื่อตรวจสอบสถานะงานตามที่อธิบายไว้ในการดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์

ตัวอย่างที่ 3: ส่งออกข้อมูลการสร้างรายได้

หากเปิดใช้การสร้างรายได้ในสภาพแวดล้อมในองค์กร คุณจะส่งออกข้อมูลได้ 2 ประเภท ดังนี้

• การส่งออกข้อมูลมาตรฐานดังที่แสดงในสองตัวอย่างก่อนหน้านี้
• การส่งออกข้อมูลการสร้างรายได้เพื่อส่งออกข้อมูลการสร้างรายได้ที่เฉพาะเจาะจง

หากต้องการส่งออกข้อมูลการสร้างรายได้ ให้ระบุ "dataset":"mint" ในเพย์โหลดคำขอ องค์กรและสภาพแวดล้อมต้องรองรับการสร้างรายได้จึงจะตั้งค่าตัวเลือกนี้ได้ มิเช่นนั้นให้ละเว้นพร็อพเพอร์ตี้ dataset จากเพย์โหลด

  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository",
    "dataset":"mint"
  }'

เกี่ยวกับโควต้า API การส่งออก

หากต้องการป้องกันการใช้การเรียก API การส่งออกข้อมูลที่มีค่าใช้จ่ายสูงมากเกินไป Edge จะบังคับใช้โควต้าสำหรับการเรียก /analytics/exports API โดยทำดังนี้

• โควต้าสำหรับองค์กรและสภาพแวดล้อมที่ไม่ได้เปิดใช้การสร้างรายได้มีดังนี้

  • การโทร 70 ครั้งต่อเดือนต่อองค์กร/สภาพแวดล้อม

  ตัวอย่างเช่น หากมี 2 สภาพแวดล้อมในองค์กรคือ prod และ test คุณจะเรียกใช้ API ได้ 70 ครั้งต่อเดือนสำหรับแต่ละสภาพแวดล้อม

• โควต้าสำหรับองค์กรและสภาพแวดล้อมที่เปิดใช้การสร้างรายได้มีดังนี้

  • การโทร 70 ครั้งต่อเดือนสำหรับแต่ละองค์กรและสภาพแวดล้อมสำหรับข้อมูลมาตรฐาน
  • การโทร 70 ครั้งต่อเดือนสำหรับแต่ละองค์กรและสภาพแวดล้อมการทำงานเพื่อขอข้อมูลการสร้างรายได้

  เช่น หากเปิดใช้การสร้างรายได้ในองค์กร prod คุณจะเรียก API สำหรับข้อมูลมาตรฐานได้ 70 ครั้งและเรียกใช้ API สำหรับข้อมูลการสร้างรายได้เพิ่มได้ 70 ครั้ง

หากคุณเกินโควต้าการเรียกใช้ API จะส่งคืนการตอบกลับ HTTP 429

การดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์ทั้งหมด

หากต้องการดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์ทั้งหมด ให้ส่งคำขอ GET ไปยัง /analytics/exports

ตัวอย่างเช่น คำขอต่อไปนี้จะแสดงสถานะของคำขอส่งออก Analytics ทั้งหมดสำหรับสภาพแวดล้อม test ในองค์กร myorg

curl -X GET \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -u email:password

ต่อไปนี้เป็นตัวอย่างการตอบกลับที่แสดงคำขอส่งออก 2 รายการ โดยคำขอหนึ่งอยู่ในคิว (สร้างและอยู่ในคิว) และอีกคำขอหนึ่งเสร็จสมบูรณ์แล้ว

[
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/e8b8db22-fe03-4364-aaf2-6d4f110444ba",
    "name": "Export results To Cloud Storage",
    "description": "One-time export to Google Cloud Storage",
    "userId": "my@email.com",
    "datastoreName": "My Cloud Storage data store",
    "executionTime": "36 seconds",
    "created": "2018-09-28T12:39:35Z",
    "updated": "2018-09-28T12:39:42Z",
    "state": "enqueued"
  },
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/9870987089fe03-4364-aaf2-6d4f110444ba"
    "name": "Export raw results to BigQuery",
    "description": "One-time export to BigQuery",
    ... 
  }
]

การดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์

หากต้องการดูสถานะของคำขอส่งออกข้อมูลวิเคราะห์ที่เฉพาะเจาะจง ให้ส่งคำขอ GET ไปยัง /analytics/exports/{exportId} โดย {exportId} คือรหัสที่เชื่อมโยงกับคำขอส่งออกข้อมูลวิเคราะห์

ตัวอย่างเช่น คำขอต่อไปนี้จะแสดงสถานะของคำขอส่งออก Analytics ที่มีรหัส 4d6d94ad-a33b-4572-8dba-8677c9c4bd98

curl -X GET \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98" \
-u email:password

ตัวอย่างการตอบกลับมีดังนี้

{
  "self":
"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98",
  "name": "Export results To Cloud Storage",
  "description": "One-time export to Google Cloud Storage",
  "userId": "my@email.com",
  "datastoreName": "My Cloud Storage data store",
  "executionTime": "36 seconds",
  "created": "2018-09-28T12:39:35Z",
  "updated": "2018-09-28T12:39:42Z",
  "state": "enqueued"
}

หากการส่งออกการวิเคราะห์ไม่แสดงข้อมูลวิเคราะห์ ระบบจะตั้งค่า executionTime เป็น "0 วินาที"

ส่งออกการอ้างอิงพร็อพเพอร์ตี้คำขอ

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ที่คุณส่งในเนื้อหาคำขอในรูปแบบ JSON เมื่อส่งออกข้อมูล Analytics

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

เช่น

{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }