صادرات/واردات تعاریف گزارش سفارشی

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

شما می‌توانید از APIهای Edge برای خروجی گرفتن و وارد کردن گزارش‌های سفارشی از یک محیط سازمانی به محیط سازمانی دیگر استفاده کنید. این تکنیک مفید به شما امکان می‌دهد طرح‌های گزارش سفارشی مورد علاقه خود را در سازمان‌ها و محیط‌های مختلف دوباره استفاده کنید. علاوه بر این، می‌توانید طرح (یک فایل متنی ساده JSON) را در CSV خود ذخیره کنید.

ابتدا، از API تعاریف گزارش‌های تحلیلی Lists برای دریافت 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"
    },
    ...
  ]
}

اکنون با فراخوانی API مربوط به Get an analytics report definition، از UUID گزارش مورد نظر برای بازیابی تعریف آن استفاده کنید. در این مثال، تعریف گزارشی با نام "My Report 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 برای سازمان مشاهده کنید.