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) 的文件。所有 EventId 小于或等于此 ULID 的所有使用事件将被删除。

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：内部服务器错误。