IP 池 ip-pools

管理员维护的 IP 池及池内 IP;池按区域归属,名称全平台唯一。

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

IP 产品线鉴权: 仅管理员12 个接口

鉴权

请求头带 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-pools列出 IP 池

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
region_idinteger 按区域过滤。
POST/api/v2/ip-pools创建 IP 池

鉴权: 仅管理员

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
region_id必填integer 区域 ID
GET/api/v2/ip-pools/candidatesIP 池候选节点 IP

鉴权: 仅管理员

查询参数

字段类型说明
region_id必填integer 区域 ID。
PUT/api/v2/ip-pools/{id}修改 IP 池

鉴权: 仅管理员

请求体 application/json

字段类型说明
desstring 备注说明
name必填string 名称
region_id必填integer 区域 ID
GET/api/v2/ip-pools/{id}/refsIP 池引用站点

鉴权: 仅管理员

查询参数

字段类型说明
ip_idinteger 只看这个池内 IP。
limitinteger 每个 IP 最多列几个站点。
默认 20
GET/api/v2/ip-pools/{pool_id}/ips列出池内 IP

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
POST/api/v2/ip-pools/{pool_id}/ipsIP 入池

鉴权: 仅管理员

请求体 application/json

字段类型说明
bind_addrstring 节点上实际监听的本机地址(NAT 场景);null = 用 ip。
node_id必填integer 节点 ID
PUT/api/v2/ip-pools/{pool_id}/ips/{id}修改池内 IP

鉴权: 仅管理员

请求体 application/json

字段类型说明
bind_addrstring 节点上实际监听的本机地址(NAT 场景);null = 用 ip。
enabledboolean 是否启用
POST/api/v2/ip-pools/{pool_id}/ips/{id}/issue-cert签发池内 IP 的平台证书

鉴权: 仅管理员

请求体 application/json

字段类型说明
confirmboolean 已有有效证书时确认重签。

IP 池对象

字段类型说明
bind_addrstring 节点上实际监听的本机地址(NAT 场景);null = 用 ip。
certIpCertState 平台 IP 证书状态。
confirmboolean 已有有效证书时确认重签。
created_atstring 创建时间
只读
desstring 备注说明
enabledboolean 是否启用
hintsstring[] 提示(如节点没上报网卡地址,入池未核对)。
只读
idinteger 记录 ID
只读
ipstring IP 地址。
只读
ip_countinteger 池内 IP 数。
只读
ipsobject[] 有引用的池内 IP 及其引用站点。
itemsIpCandidate[] 本页条目
namestring 名称
node_idinteger 节点 ID
node_namestring 所属节点名称。
只读
node_stateIpNodeState 持有主节点状态:停用 disabled;否则最近 2 分钟有心跳 online,没有 offline。
可选值 ["online","offline","disabled"]
pool_idinteger 所属 IP 池 ID。
只读
region_idinteger 区域 ID
region_namestring 区域名称。
只读
site_countinteger 引用池内 IP 的 IP 站点数(按站点去重)。
只读
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"
}
开始使用

体验在线演示

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