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 TMP que contém eventos de execução. Se você receber uma resposta 200 OK, um link Baixar arquivo será fornecido para baixar o arquivo.

Depois de baixar o relatório de uso, vá para a interface do Alteryx Analytics Cloud (AAC) e carregue o mesmo...

  1. Faça login no AAC como Administrador do espaço de trabalho.

  2. Acesse o menu "Perfil" > Administrador do espaço de trabalho.

  3. Acesse Monitoramento > Uso do Server offline.

  4. Selecione Carregar dados do Server.

  5. Arraste e solte ou procure o seu relatório de uso (arquivo TMP) e selecione Carregar.

Quando o carregamento para o AAC for concluído, um arquivo de confirmação com o ID de evento do último registro fornecido será salvo automaticamente na sua pasta "Downloads". Pegue o arquivo de resposta e carregue-o de volta para o Server conforme descrito em Carregar arquivo de resposta de uso do Server do AAC para o Server.

Nota

Somente administradores do Server podem usar esse ponto de extremidade.

Parâmetros

Sem parâmetros.

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

  • 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).

Carregar arquivo de resposta de uso do Server do AAC para o Server

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

Carregue o arquivo de resposta retornado pelo AAC para o Server 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 esse ULID são excluídos.

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'

  • 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).