所有端点均需 快速上手 中描述的签名认证。自助签发的只读密钥可访问全部 GET 端点; 电源操作仅全功能密钥可用。
GET /api/v1/openapi/account — 账户信息
GET /api/v1/openapi/instances — 实例列表
名下实例(排除已删除),按创建倒序,最多 100 条。单实例字段:
GET /api/v1/openapi/instances/:uuid — 实例详情
字段同上;实例不存在或不属于该密钥持有人时返回 404。
GET /api/v1/openapi/orders — 订单列表
最近 50 条订单记录(含金额、周期、状态;开通异常文案已脱敏)。
POST /api/v1/openapi/instances/:uuid/power — 电源操作
请求体 {"action": "start | stop | reboot"},仅全功能密钥可用(只读密钥返回 403)。成功返回 {"uuid": …, "status": …}。
curl -X POST "https://heyiwei.com.cn/api/v1/openapi/instances/<uuid>/power" \
-H "X-Access-Key: uak_xxxxxxxx" \
-H "X-Timestamp: <unix秒>" \
-H "X-Nonce: <随机串>" \
-H "X-Signature: <签名>" \
-H "Content-Type: application/json" \
-d '{"action":"reboot"}'电源操作会按密钥持有人身份记入操作日志;请妥善保管密钥。
财务对接端点(finance 密钥专用)
以下四个端点面向站内财务系统拉取全平台资金明细,与上面自助签发的密钥是两条独立权限线: 仅管理员签发的 finance 专用密钥可访问,自助只读/全功能密钥调用一律 403。口径与报税导出一致。
GET /api/v1/openapi/finance/payments— 支付流水增量拉取(状态迁移推动 updated_at,按 since 重拉即得新状态)GET /api/v1/openapi/finance/refunds— 退款明细(含 processing/failed,财务侧按 status 过滤)GET /api/v1/openapi/finance/ledger— 账本流水(余额变动明细)GET /api/v1/openapi/finance/summary?since=&until=— 时间窗口合计
公共查询参数:since / until(时间窗,ISO 时间)、cursor(keyset 游标,按 updated_at+id 严格递增翻页)、uid(按账户过滤)、limit(默认 200,上限 1000)。 返回含 next_cursor 与 has_more,游标为空即拉完。
