Exportar/importar definições de relatório personalizadas

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

É possível usar as APIs Edge para exportar e importar relatórios personalizados de um ambiente organizacional para outro. Essa técnica útil permite reutilizar designs de relatórios personalizados que você gosta em diferentes organizações e ambientes. Além disso, é possível armazenar o design (um arquivo de texto JSON simples) no CSV.

Primeiro, use a API Listas de definições dos relatórios de análise para ver os UUIDs de todos os relatórios definidos para uma organização:

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

Para cada relatório, a saída contém o nome de exibição (o nome que você vê na IU do Edge) e o UUID dele:

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

Agora, use o UUID do relatório desejado para recuperar a definição dele chamando a API Receber uma definição do relatório de análise. Neste exemplo, você obtém a definição do relatório chamado "Meu relatório":

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

A saída contém a definição do relatório:

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

Copie a saída JSON e atualize os campos environment e organization conforme necessário para o destino. Em seguida, importe a definição usando a API Criar uma definição do relatório de análise.

Por exemplo, se quiser importar a definição para o ambiente test de uma organização chamada 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 

Agora você verá o relatório na IU do Edge da organização.