IP 池
管理员维护的 IP 池及池内 IP;池按区域归属,名称全平台唯一。
ip-poolsIP 产品线鉴权: 仅管理员12 个接口列出 IP 池
GET
/api/v2/ip-pools鉴权: 仅管理员
查询参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | integer | — | 页码,从 1 开始。 |
| page_size | integer | — | 每页条数。 |
| sort | string | — | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
| region_id | integer | — | 按区域过滤。 |
创建 IP 池
POST
/api/v2/ip-pools鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| des | string | — | 备注说明 |
| name | string | 必填 | 名称 |
| region_id | integer | 必填 | 区域 ID |
IP 池候选节点 IP
GET
/api/v2/ip-pools/candidates鉴权: 仅管理员
查询参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| region_id | integer | 必填 | 区域 ID。 |
获取 IP 池
GET
/api/v2/ip-pools/{id}鉴权: 仅管理员
修改 IP 池
PUT
/api/v2/ip-pools/{id}鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| des | string | — | 备注说明 |
| name | string | 必填 | 名称 |
| region_id | integer | 必填 | 区域 ID |
删除 IP 池
DELETE
/api/v2/ip-pools/{id}鉴权: 仅管理员
IP 池引用站点
GET
/api/v2/ip-pools/{id}/refs鉴权: 仅管理员
查询参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ip_id | integer | — | 只看这个池内 IP。 |
| limit | integer | — | 每个 IP 最多列几个站点。 |
列出池内 IP
GET
/api/v2/ip-pools/{pool_id}/ips鉴权: 仅管理员
查询参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | integer | — | 页码,从 1 开始。 |
| page_size | integer | — | 每页条数。 |
| sort | string | — | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
IP 入池
POST
/api/v2/ip-pools/{pool_id}/ips鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bind_addr | string | — | 节点上实际监听的本机地址(NAT 场景);null = 用 ip。 |
| node_id | integer | 必填 | 节点 ID |
修改池内 IP
PUT
/api/v2/ip-pools/{pool_id}/ips/{id}鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bind_addr | string | — | 节点上实际监听的本机地址(NAT 场景);null = 用 ip。 |
| enabled | boolean | — | 是否启用 |
IP 出池
DELETE
/api/v2/ip-pools/{pool_id}/ips/{id}鉴权: 仅管理员
签发池内 IP 的平台证书
POST
/api/v2/ip-pools/{pool_id}/ips/{id}/issue-cert鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| confirm | boolean | — | 已有有效证书时确认重签。 |
IP 池对象
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| bind_addr | string | — | 节点上实际监听的本机地址(NAT 场景);null = 用 ip。 |
| cert | IpCertState | — | 平台 IP 证书状态。 |
| confirm | boolean | — | 已有有效证书时确认重签。 |
| created_at | string | — | 创建时间 |
| des | string | — | 备注说明 |
| enabled | boolean | — | 是否启用 |
| hints | string[] | — | 提示(如节点没上报网卡地址,入池未核对)。 |
| id | integer | — | 记录 ID |
| ip | string | — | IP 地址。 |
| ip_count | integer | — | 池内 IP 数。 |
| ips | object[] | — | 有引用的池内 IP 及其引用站点。 |
| items | IpCandidate[] | — | 本页条目 |
| name | string | — | 名称 |
| node_id | integer | — | 节点 ID |
| node_name | string | — | 所属节点名称。 |
| node_state | IpNodeState | — | 持有主节点状态:停用 disabled;否则最近 2 分钟有心跳 online,没有 offline。 |
| pool_id | integer | — | 所属 IP 池 ID。 |
| region_id | integer | — | 区域 ID |
| region_name | string | — | 区域名称。 |
| site_count | integer | — | 引用池内 IP 的 IP 站点数(按站点去重)。 |
| updated_at | string | — | 更新时间 |