Skip to main content

Pontos de extremidade de uso

Recuperar execuções de uso do Server

Este ponto de extremidade é usado para geração de relatórios de uso offline.

Para recuperar os detalhes sobre todas as execuções de uso do Server, use o ponto de extremidade GET {baseURL}/v3/usage. Este ponto de extremidade retorna um arquivo que contém eventos de execução e deve ser salvo como um arquivo TMP ou AVRO.

Depois de baixar o relatório de uso, vá para a interface do Alteryx Analytics Cloud (AAC) e carregue o mesmo. Quando o carregamento (upload) para o AAC for concluído, um arquivo de resposta será gerado. Pegue o arquivo de resposta e carregue o mesmo de volta para o Server conforme descrito em "Carregar arquivo de resposta de uso do Server para o AAC".

  1. Sign in to AAC as a Workspace Admin.

  2. Go to your Profile menu > Workspace Admin.

  3. Go to Monitoring > Offline Server Usage.

  4. Select Upload Server Data.

  5. Drag and drop or browse to your usage report (TMP file) and select Upload.

When the upload to AAC completes, a confirmation file with the last provided record’s event ID will be automatically saved to your Downloads folder. Take the response file and upload it back to Server as described in Upload Server Usage AAC Response File to Server.

Nota

Somente administradores do Server podem usar esse ponto de extremidade.

Parâmetros

Sem parâmetros.

Exemplo de solicitação: cURL

curl -X 'GET' \
  'http://pod-6650776.extendthereach.com/webapi/v3/usage' \
  -H 'accept: application/octet-stream' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Exemplo de resposta

  • 200: Download usage records as a file. (200: Baixar registros de uso como um arquivo).

  • 401: Unauthorized (401: Não autorizado).

  • 404: No records are available for download. (404: Nenhum registro está disponível para download).

  • 500: InternalServerError (500: Erro interno do servidor).

Fazer upload do arquivo de resposta de uso do Server para o AAC

Este ponto de extremidade é usado para geração de relatórios de uso offline.

Após carregar o relatório de uso pela interface do AAC, carregue o arquivo de resposta retornado usando o ponto de extremidade POST {baseURL}/v3/usage.

Quando o arquivo do AAC for processado com sucesso pela chamada POST, os eventos de execução relatados serão excluídos do banco de dados. O próximo arquivo gerado pela chamada GET /v3/usage recuperará eventos de execução que ocorreram após a última chamada GET.

Nota

Somente administradores do Server podem usar esse ponto de extremidade.

Parâmetros

file (formData): obrigatório. Carregar um arquivo que contenha um único ULID (EventID). Todos os eventos de uso com EventIds menores ou iguais a este ULID serão excluídos.

Exemplo de solicitação: cURL

curl -X 'POST' \
  'http://pod-6650776.extendthereach.com/webapi/v3/usage' \
  -H 'accept: application/json' \
  -H 'authorization: BearerTokenGoesHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@ServerUsage.csv;type=text/csv'

Exemplo de resposta

  • 200: AAC response file processed and usage events cleanup complete. (200: Arquivo de resposta do AAC processado e limpeza de eventos de uso concluída).

  • 400: Missing or empty AAC response file. (400Arquivo de resposta do AAC ausente ou vazio).

  • 401: Unauthorized (401: Não autorizado). Ocorre se um usuário que não é administrador tentar usar este ponto de extremidade, ou se um segredo ou chave incorretos forem fornecidos.

  • 500: InternalServerError (500: Erro interno do servidor).

Nesta secção: