Skip to main content

使用状況エンドポイント

Server使用(実行)状況を取得する

このエンドポイントは、オフラインでの使用状況のレポーティングに使用されます。

すべてのServer使用(実行)状況に関する情報を取得するには、GET {baseURL}/v3/usageエンドポイントを使用します。このエンドポイントは、実行イベントを含むTMPファイルを返します。200 OK応答を受け取った場合は、ファイルをダウンロードするための[ファイルのダウンロード]リンクが提供されます。

使用状況レポートをダウンロードしたら、Alteryx Analytics Cloud (AAC)のUIに移動してアップロードします。

  1. ワークスペース管理者としてAACにサインインします。

  2. [プロファイル]メニュー > [ワークスペース管理者]の順に移動します。

  3. [モニタリング] > [オフラインのServer使用状況]の順に移動します。

  4. [Serverデータのアップロード]を選択します。

  5. 使用状況レポート(TMPファイル)をドラッグアンドドロップまたは参照し、[アップロード]を選択します。

AACへのアップロードが完了すると、最後に提供されたレコードのイベントIDを含む確認ファイルが自動的に[ダウンロード]フォルダーに保存されます。Server使用状況AAC応答ファイルをServerにアップロードするの説明に従って、応答ファイルを取得してServerに再度アップロードします。

注記

このエンドポイントを使用できるのはServer管理者のみです。

パラメーター

パラメーターはありません。

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

  • 200: 使用状況レコードをファイルとしてダウンロードします。

  • 401: 認証エラー。

  • 404: ダウンロードできるレコードがありません。

  • 500: 内部サーバーエラー。

Server使用状況AAC応答ファイルをServerにアップロードする

このエンドポイントは、オフラインでの使用状況のレポーティングに使用されます。

POST {baseURL}/v3/usageエンドポイントを使用して、AACから返された応答ファイルをServerにアップロードします。

AACファイルがPOST呼び出しで正常に処理されると、報告された実行イベントはデータベースから削除されます。GET /v3/usage呼び出しによって生成される次のファイルは、最後のGET呼び出しの後に発生した実行イベントを取得します。

注記

このエンドポイントを使用できるのはServer管理者のみです。

パラメーター

file (formData): 必須です。単一のULID (EventID)を含むファイルをアップロードします。このULID以下のEventIdを持つすべての使用状況イベントが削除されます。

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応答ファイルが処理され、使用状況イベントのクリーンアップが完了しました。

  • 400: AAC応答ファイルがないか空です。

  • 401: 認証エラー。管理者以外のユーザーがこのエンドポイントを使用しようとした場合、または誤ったシークレットもしくはキーが指定された場合に発生します。

  • 500: 内部サーバーエラー。