Mengekspor/mengimpor definisi laporan kustom

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Anda dapat menggunakan Edge API untuk mengekspor dan mengimpor laporan kustom dari satu lingkungan organisasi ke lingkungan organisasi lainnya. Teknik yang bermanfaat ini memungkinkan Anda menggunakan kembali desain laporan kustom yang Anda sukai di berbagai organisasi dan lingkungan. Selain itu, Anda dapat menyimpan desain (file teks JSON sederhana) di CSV.

Pertama, gunakan API Lists analytics report definition untuk mendapatkan UUID semua laporan yang ditentukan untuk organisasi:

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

Untuk setiap laporan, output-nya berisi nama tampilan (nama yang Anda lihat di UI Edge) dan UUID-nya:

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

Sekarang, gunakan UUID laporan yang diinginkan untuk mengambil definisinya dengan memanggil API Get an analytics report definition. Dalam contoh ini, Anda mendapatkan definisi laporan bernama "Laporan Saya 1":

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

Output-nya berisi definisi laporan:

{
  "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"
}

Salin output JSON dan perbarui kolom environment dan organization seperlunya untuk tujuan, lalu impor definisi menggunakan Create an analytics report definition API.

Misalnya, untuk mengimpor definisi ke lingkungan test dari sebuah organisasi bernama 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 

Sekarang Anda akan melihat laporan di UI Edge untuk organisasi.