Eksportuj/importuj definicje raportów niestandardowych

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X.
info

Za pomocą interfejsów Edge API możesz eksportować i importować raporty niestandardowe z jednego środowiska organizacji do innego. Ta przydatna technika umożliwia ponowne wykorzystywanie projektów raportów niestandardowych, które Ci się podobają, w różnych organizacjach i środowiskach. Ponadto możesz przechowywać projekt (prosty plik tekstowy JSON) w pliku CSV.

Najpierw użyj interfejsu API do wyświetlania definicji raportów Analytics List, aby uzyskać identyfikatory UUID wszystkich raportów zdefiniowanych dla organizacji:

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

W przypadku każdego raportu dane wyjściowe zawierają jego nazwę wyświetlaną (nazwę widoczną w interfejsie Edge) i identyfikator UUID:

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

Teraz użyj identyfikatora UUID żądanego raportu, aby pobrać jego definicję, wywołując interfejs API do pobierania definicji raportu Analytics. W tym przykładzie pobierasz definicję raportu o nazwie „Mój raport 1”:

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

Dane wyjściowe zawierają definicję raportu:

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

Skopiuj dane wyjściowe JSON i w razie potrzeby zaktualizuj pola environment i organization dla miejsca docelowego, a następnie zaimportuj definicję za pomocą interfejsu API do tworzenia definicji raportu Analytics.

Aby na przykład zaimportować definicję do środowiska test organizacji o nazwie 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 

Raport powinien być teraz widoczny w interfejsie Edge organizacji.