版本 2.4.7.20261116085428 · 最新

转发分组 stream-groups

给四层转发规则分组,便于批量管理;同租户分组名唯一,分组里还有转发时不能删除。

点击任一接口,右侧显示对应的调用示例。

四层转发鉴权: 用户(部分参数仅管理员)5 个接口

鉴权

请求头带 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。

GET/api/v2/stream-groups列出四层转发分组

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
POST/api/v2/stream-groups创建四层转发分组

鉴权: 用户(部分参数仅管理员)

查询参数

字段类型说明
tenant_idinteger 管理员代建时的属主租户(必填);租户调用时忽略,属主恒为本人。

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
GET/api/v2/stream-groups/{id}获取四层转发分组

鉴权: 用户(部分参数仅管理员)

PUT/api/v2/stream-groups/{id}修改四层转发分组

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
DELETE/api/v2/stream-groups/{id}删除四层转发分组

鉴权: 用户(部分参数仅管理员)

转发分组对象

字段类型说明
created_atstring 创建时间
只读
desstring 备注说明
idinteger 记录 ID
只读
namestring 名称
tenant_idinteger 所属租户(用户)ID
只读
updated_atstring 更新时间
只读

返回与错误

成功直接回资源 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"
}
开始使用

123

123