版本 2.4.8 · 最新
用户级默认配置 user-defaults
新建站点或四层转发时带入的默认字段,按类型分别保存。
点击任一接口,右侧显示对应的调用示例。
运维与系统鉴权: 用户3 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
PUT
/api/v2/user-defaults/{kind}修改用户级默认配置
鉴权: 用户
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
expected_updated_at | string | 乐观锁:调用方读到的 updated_at(读到 updated_at 为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。 |
value必填 | object | 默认字段(站点/四层契约的顶层字段子集)。 |
用户级默认配置对象
| 字段 | 类型 | 说明 |
|---|---|---|
expected_updated_at | string | 乐观锁:调用方读到的 updated_at(读到 updated_at 为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。 |
kind | string | 默认配置类型:site 站点;stream 四层转发。 |
updated_at | string | 更新时间 |
value | object | 默认字段(站点/四层契约的顶层字段子集)。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}