تصدير/استيراد تعريفات التقارير المخصّصة

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info

يمكنك استخدام واجهات برمجة تطبيقات Edge لتصدير التقارير المخصّصة واستيرادها من بيئة مؤسسة إلى أخرى. تتيح لك هذه الطريقة المفيدة إعادة استخدام تصاميم التقارير المخصّصة التي تعجبك في مؤسسات وبيئات مختلفة. علاوةً على ذلك، يمكنك تخزين التصميم (ملف نصي بسيط بتنسيق JSON) في ملف CSV.

أولاً، استخدِم واجهة برمجة التطبيقات Lists analytics report definitions للحصول على المعرّفات الفريدة العالمية (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) للتقرير المطلوب لاسترداد تعريفه من خلال استدعاء واجهة برمجة التطبيقات Get an analytics report definition 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 حسب الحاجة للوجهة، ثم استورِد التعريف باستخدام Create an analytics report definition 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 للمؤسسة.