IP 站点 ip-sites

用 IP 加自定义端口对外提供加速的站点;须先在用户套餐里选好 IP。

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

IP 产品线鉴权: 用户(部分参数仅管理员)8 个接口

鉴权

请求头带 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/ip-sites列出 IP 站点

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

查询参数

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

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

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。

请求体 application/json

字段类型说明
configobject 节点配置字段(同站点 config;kind 恒为 ip,listen_addrs 发布时由绑定现取)。
enabledboolean 是否启用
ip_idsinteger[] 绑定的池内 IP id(按次序)。
namestring 名称
originsIpSiteOrigin[] 源站列表。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
upidinteger 用户套餐 id。
GET/api/v2/ip-sites/available-ipsIP 站点可选 IP

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

查询参数

字段类型说明
upid必填integer 用户套餐 ID。
scopestring pool 整池;mine 只列已选。
可选值 ["pool","mine"]默认 "pool"
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
POST/api/v2/ip-sites/port-checkIP 站点端口预检

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

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。

请求体 application/json

字段类型说明
http_portsinteger[] 要检查的 HTTP 端口列表;超出 1~65535 的不拒,结果里标 range。
https_portsinteger[] 要检查的 HTTPS 端口列表;超出 1~65535 的不拒,结果里标 range。
ip_ids必填integer[] 绑定的池内 IP id(按次序)。
site_idinteger 改站时给:本站自己占的不算占用。
upid必填integer 用户套餐 id。
GET/api/v2/ip-sites/{id}获取 IP 站点

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

PUT/api/v2/ip-sites/{id}修改 IP 站点

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

请求体 application/json

字段类型说明
configobject 节点配置字段(同站点 config;kind 恒为 ip,listen_addrs 发布时由绑定现取)。
enabledboolean 是否启用
ip_idsinteger[] 绑定的池内 IP id(按次序)。
namestring 名称
originsIpSiteOrigin[] 源站列表。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
upidinteger 用户套餐 id。
DELETE/api/v2/ip-sites/{id}删除 IP 站点

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

GET/api/v2/ip-sites/{id}/healthIP 站点回源健康状态

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

IP 站点对象

字段类型说明
access_addrsstring[] 访问地址 ip:端口。
只读
checked_atstring 本次向节点要明细的时间。
configobject 节点配置字段(同站点 config;kind 恒为 ip,listen_addrs 发布时由绑定现取)。
created_atstring 创建时间
只读
enabledboolean 是否启用
hintsstring[] 提示(如节点没上报在听端口,跳过了该项检查)。
只读
http_portsinteger[] 要检查的 HTTP 端口列表;超出 1~65535 的不拒,结果里标 range。
https_portsinteger[] 要检查的 HTTPS 端口列表;超出 1~65535 的不拒,结果里标 range。
idinteger 记录 ID
只读
ip_idsinteger[] 绑定的池内 IP id(按次序)。
ipsIpSiteIp[] 绑定的池内 IP 详情。
只读
itemsAvailableIp[] 本页条目
namestring 名称
nodesSiteHealthNode[] 各在用节点的明细(按节点 id 升序)。
originsIpSiteOrigin[] 源站列表。
portsobject[] 逐端口检查结果。
site_idinteger 改站时给:本站自己占的不算占用。
statusstring disabled 没开主动健康检查;unknown 没有节点回明细;healthy 回了明细的节点上源站全部在线;unhealthy 有源站被摘除。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
tenant_idinteger 所属租户(用户)ID
只读
updated_atstring 更新时间
只读
upidinteger 用户套餐 id。

返回与错误

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

体验在线演示

访问在线演示,或联系我们获取报价与安装命令