Definitionen für benutzerdefinierte Berichte exportieren/importieren

Sie sehen die Apigee Edge-Dokumentation.
Rufen Sie die Apigee X-Dokumentation auf.
weitere Informationen

Sie können Edge APIs verwenden, um benutzerdefinierte Berichte von einer Organisationsumgebung in eine andere zu exportieren und zu importieren. Mit dieser nützlichen Technik können Sie benutzerdefinierte Berichtsdesigns wiederverwenden, die Sie in verschiedenen Organisationen und Umgebungen mögen. Darüber hinaus können Sie das Design (eine einfache JSON-Textdatei) in Ihrer CSV-Datei speichern.

Verwenden Sie zuerst die API für Lists Analytics-Berichtsdefinitionen, um die UUIDs aller für eine Organisation definierten Berichte abzurufen:

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

Für jeden Bericht enthält die Ausgabe den Anzeigenamen (den in der Edge-Benutzeroberfläche angezeigten Namen) und die UUID:

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

Verwenden Sie nun die UUID des gewünschten Berichts, um die Definition abzurufen, indem Sie die API Analyseberichtsdefinition abrufen aufrufen. In diesem Beispiel erhalten Sie die Definition des Berichts „Mein Bericht 1“:

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

Die Ausgabe enthält die Berichtsdefinition:

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

Kopieren Sie die JSON-Ausgabe und aktualisieren Sie die Felder environment und organization nach Bedarf für das Ziel. Importieren Sie dann die Definition mithilfe der API zum Erstellen einer Analyseberichtsdefinition.

So importieren Sie beispielsweise die Definition in die test-Umgebung einer Organisation namens 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 

Der Bericht sollte jetzt in der Edge-Benutzeroberfläche für die Organisation angezeigt werden.