ייצוא/ייבוא הגדרות של דוח בהתאמה אישית

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

תוכלו להשתמש בממשקי API של Edge כדי לייצא ולייבא דוחות מותאמים אישית מסביבה ארגונית אחת לאחרת. הטכניקה השימושית הזו מאפשרת לך לעשות שימוש חוזר בעיצובים מותאמים אישית של דוחות שאתה אוהב בארגונים שונים, בסביבות שונות. בנוסף, אפשר לשמור את העיצוב (קובץ טקסט פשוט בפורמט JSON) בקובץ ה-CSV.

קודם כול, משתמשים בהגדרות של דוח ניתוח נתוני רשימות API לקבלת המזהים הייחודיים (UUID) של כל הדוחות שהוגדרו לארגון:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/org-name/reports" \
  -u email:password

בכל דוח, הפלט מכיל את השם המוצג שלו (השם שמופיע בממשק המשתמש של Edge) ואת ה-UUID שלו:

{
  "qualifier": [
    {
      "displayName": "My Report 1",
      "name": "cb7cd16a-44c4-0bc83c3b9c92"
    },
    {
      "displayName": "My Other Report",
      "name": "a7e3fc4e-992a2ffc0e3d49d"
    },
    ...
  ]
}

עכשיו משתמשים ב-UUID של הדוח הרצוי כדי לאחזר את ההגדרה שלו. לשם כך, מפעילים את הפונקציה קבלת הגדרה של דוח ניתוח נתונים API. בדוגמה הזו מקבלים את ההגדרה של הדוח בשם 'הדוח שלי 1':

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/org-name/reports/cb7cd16a-44c4-0bc83c3b9c92" \
  -u email:password

הפלט מכיל את הגדרת הדוח:

{
  "chartType": "column",
  "comments": [],
  "createdAt": 1506922614000,
  "createdBy": "11.111.121.57",
  "dimensions": [
    "apiproxy",
    "proxy_pathsuffix",
    "proxy_client_ip"
  ],
  "displayName": "My Report 1",
  "environment": "prod",
  "lastModifiedAt": 1512435450000,
  "lastModifiedBy": "111.111.121.57",
  "lastViewedAt": 1512435450000,
  "metrics": [
    {
      "function": "avg",
      "name": "response_size"
    },
    {
      "function": "avg",
      "name": "request_size"
    }
  ],
  "name": "cb7cd16a-44c4-0bc83c3b9c92",
  "organization": "myOrg",
  "properties": [
    {
      "property": "__ui__",
      "value": [
        {
          "name": "description"
        },
        {
          "name": "accuracy"
        }
      ]
    }
  ],
  "sortbyCols": [],
  "tags": [],
  "timeUnit": "hour"
}

מעתיקים את פלט ה-JSON ומעדכנים את השדות environment ו-organization לפי הצורך ליעד, ואז לייבא את ההגדרה באמצעות ממשק API של יצירת הגדרת דוח ניתוח נתונים.

לדוגמה, כדי לייבא את ההגדרה לסביבה test של ארגון בשם destOrg:

curl -X POST -H "Content-Type: application/json" "https://api.enterprise.apigee.com/v1/organizations/destOrg/reports" \
-d "{
  "chartType": "column",
  "comments": [],
  "createdAt": 1506922614000,
  "createdBy": "11.111.121.57",
  "dimensions": [
    "apiproxy",
    "proxy_pathsuffix",
    "proxy_client_ip"
  ],
  "displayName": "My Report 1",
  "environment": "test",
  "lastModifiedAt": 1512435450000,
  "lastModifiedBy": "111.111.121.57",
  "lastViewedAt": 1512435450000,
  "metrics": [
    {
      "function": "avg",
      "name": "response_size"
    },
    {
      "function": "avg",
      "name": "request_size"
    }
  ],
  "name": "cb7cd16a-44c4-0bc83c3b9c92",
  "organization": "destOrg",
  "properties": [
    {
      "property": "__ui__",
      "value": [
        {
          "name": "description"
        },
        {
          "name": "accuracy"
        }
      ]
    }
  ],
  "sortbyCols": [],
  "tags": [],
  "timeUnit": "hour"
}" \
-u email:password

עכשיו הדוח אמור להופיע בממשק המשתמש של Edge של הארגון.