Skip to main content

使用情况端点

检索 Server 使用运行记录

此端点用于报告离线使用情况。

要检索有关所有 Server 使用运行的详细信息，请使用 GET {baseURL}/v3/usage 端点。此端点返回一个包含运行事件的文件，必须另存为 TMP 或 AVRO 文件。

下载使用情况报告后，请转至 Alteryx Analytics Cloud (AAC) UI 并上传该报告。报告成功上传到 AAC 后，系统将生成响应文件。按照“将 Server 使用情况响应文件上传到 AAC”中所述，获取响应文件并将其上传回 Server。

  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.

注意

只有管理员（Server 管理员）才能使用此端点。

参数

无参数。

请求示例：cURL

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

此端点用于报告离线使用情况。

通过 AAC UI 上传使用情况报告后，使用 POST {baseURL}/v3/usage 端点上传返回的响应文件。

当 AAC 文件通过 POST 调用成功处理后，报告的运行事件将从数据库中删除。GET /v3/usage 调用生成的下一个文件可检索上次 GET 调用之后发生的运行事件。

注意

只有管理员（Server 管理员）才能使用此端点。

参数

file (formData)：必填。上传包含单个 ULID (EventID) 的文件。EventId 小于或等于此 ULID 的所有使用事件将被删除。

请求示例：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'

响应示例

  • 200：AAC 响应文件已处理，使用事件清理已完成。

  • 400：AAC 响应文件缺失或为空。

  • 401：未获授权。如果非管理员尝试使用此端点，或者提供了错误的密钥，则会发生这种情况。

  • 500：内部服务器错误。

本节内容如下: