使用状況エンドポイント
Server使用(実行)状況を取得する
このエンドポイントは、オフラインでの使用状況のレポーティングに使用されます。
すべてのServer使用(実行)状況に関する情報を取得するには、GET {baseURL}/v3/usageエンドポイントを使用します。このエンドポイントは、実行イベントを含むファイルを返し、TMPファイルまたはAVROファイルとして保存する必要があります。
使用状況レポートをダウンロードしたら、Alteryx Analytics Cloud (AAC)のUIに移動してアップロードします。AACへのアップロードが完了すると、応答ファイルが生成されます。「AACにServer使用状況応答ファイルをアップロードする」の説明に従って、応答ファイルを取得してServerに再度アップロードします。
Sign in to AAC as a Workspace Admin.
Go to your Profile menu > Workspace Admin.
Go to Monitoring > Offline Server Usage.
Select Upload Server Data.
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.
注記
このエンドポイントを使用できるのは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: 内部サーバーエラー。
AACにServer使用状況応答ファイルをアップロードする
このエンドポイントは、オフラインでの使用状況のレポーティングに使用されます。
AAC UIを介して使用状況レポートをアップロードした後、POST {baseURL}/v3/usageエンドポイントを使用して、返された応答ファイルをアップロードします。
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: 内部サーバーエラー。