Arkvory

反馈 ​

通过此服务器发送给 ProAnimaStudio 的反馈，附带屏幕截图和日志。

本组中的操作及其访问规则、重试规则、参数和响应。每个请求都需携带密钥：Authorization: Bearer <密钥>（参见“身份验证”）。

操作 ​

向 ProAnimaStudio 发送反馈 ​

POST /api/v1/feedback

访问: 任何有效的密钥或会话 · 重试: 请勿自动重试

通过本服务器把消息转发给 ProAnimaStudio 中心（hub），并返回 202 和中心给出的 id。需发送 message（最长 20 000 个字符）、lang（ru 或 en）、serverLog（为 true 时附上本服务器的日志和系统摘要，仅限管理员），以及可选的用于回复的 email、screen、最多 6 张 base64 编码的 screenshots（PNG、JPEG、WebP 或 GIF，每张 8 MiB）和控制台的 clientLog；总大小限制为 15 MiB。不会重试，因此第二次调用就是第二条消息。运维人员关闭该功能时返回 503 feedback_disabled，中心无响应时返回 503 hub_unreachable，本服务器发送过多时返回 429 feedback_attempts。

请求正文 (application/json)

字段类型必需规则
messagestring是1–20000 个字符
emailstring否最多 254 个字符; 可以为 null
langstring是取值之一：ru, en
screenstring否最多 11 个字符; 可以为 null
screenshots数组（object）是最多 6 项
screenshots[].namestring是1–120 个字符
screenshots[].typestring是取值之一：image/png, image/jpeg, image/webp, image/gif
screenshots[].datastring (byte)是—
clientLogstring否最多 2097152 个字符; 可以为 null
serverLogboolean是—

响应 202

字段类型必需规则
idstring是—

响应: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

示例

bash
curl -X POST "$ARKVORY_URL/api/v1/feedback" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message":"<message>","lang":"ru","screenshots":[],"serverLog":false}'

预览反馈附件 ​

GET HEAD /api/v1/feedback/attachments

访问: 管理员 · 重试: 可安全重试（读取）

返回当 serverLog 为 true 时 sendFeedback 会附上的两段文本：本服务器日志的近期记录，以及不含地址、名称或机密值的系统摘要（版本、操作系统、更新和镜像状态）。发送前请先展示给管理员。

响应 200

字段类型必需规则
serverLogstring是—
systemstring是—

响应: 200, 400, 401, 403, 404, 409, 422, 503, 507

示例

bash
curl -X GET "$ARKVORY_URL/api/v1/feedback/attachments" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Arkvory · ProAnimaStudio