Skip to main content

Points de terminaison d'utilisation

Obtenir des informations sur les exécutions d'utilisation de Server

Ce point de terminaison est utilisé pour le reporting de l'utilisation hors ligne.

Pour obtenir des informations sur toutes les exécutions d'utilisation de Server, utilisez le point de terminaison GET {baseURL}/v3/usage. Ce point de terminaison renvoie un fichier contenant les événements d'exécution et doit être enregistré en tant que fichier TMP ou AVRO.

Après avoir téléchargé le rapport d'utilisation, accédez à l'interface utilisateur d'Alteryx Analytics Cloud (AAC) et chargez-le. Une fois le chargement vers AAC terminé, un fichier de réponse est généré. Rechargez le fichier de réponse vers Server comme décrit dans la section

  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.

Note

Seuls les Administrateurs (administrateurs Server) peuvent utiliser ce point de terminaison.

Paramètres

Aucun paramètre.

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.

  • 401: Unauthorized.

  • 404: No records are available for download.

  • 500: InternalServerError.

Charger le fichier de réponse AAC d'utilisation de Server vers Server

Ce point de terminaison est utilisé pour le reporting de l'utilisation hors ligne.

Chargez le fichier de réponse renvoyé par AAC sur Server à l'aide du point de terminaison POST {baseURL}/v3/usage.

Une fois le fichier AAC traité par l'appel POST, les événements d'exécution signalés sont supprimés de la base de données. Le fichier suivant généré par l'appel GET /v3/usage permet d'obtenir les événements d'exécution qui se sont produits après le dernier appel GET.

Note

Seuls les Administrateurs (administrateurs Server) peuvent utiliser ce point de terminaison.

Paramètres

file (formData) : obligatoire. Chargez un fichier contenant un seul ULID (EventID). Tous les événements d'utilisation avec des EventID inférieurs ou égaux à cet ULID sont supprimés.

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.

  • 400: Missing or empty AAC response file.

  • 401: Unauthorized. Ce cas se produit si un utilisateur qui n'est pas un Administateur tente d'utiliser ce point de terminaison ou si un secret ou une clé incorrects sont fournis.

  • 500: InternalServerError.