## 节点分组 (`node-groups`)

把线路编成组并对应一个接入名;可设置备用阈值,可用线路不足时自动切到备用组。

鉴权: 仅管理员 · 文档: https://www.gocdn888.com/zh/docs/api/node-groups

### GET `/api/v2/node-groups`

列出节点分组 · 鉴权: 仅管理员

查询参数:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `page` | integer |  | 页码,从 1 开始。 默认: 1 |
| `page_size` | integer |  | 每页条数。 默认: 20 |
| `sort` | string |  | 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。 |
| `ids` | string |  | 只列这些 id:逗号分隔的正整数,去重后至多 200 个(同 page_size 上限,超了或格式错 422);空串等同不传。与其他条件取交集;看不到的 id 不返回也不报错。分页照旧,一次取回要把 page_size 设成不少于 id 个数。 |

```sh
curl "https://panel.example.com/api/v2/node-groups" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### POST `/api/v2/node-groups`

创建节点分组 · 鉴权: 仅管理员

请求体:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `backup_interval_s` | integer |  | interval 方式的轮换间隔(秒)。 |
| `backup_ip_num` | integer |  | interval 方式每轮在用的备用 IP 数。 |
| `backup_min_online` | integer |  | 组内可用线路少于它就把引用本组的接入名自动切到各自的备用组;0 = 不自动切,缺省 1(可用为 0 即切)。 |
| `backup_switch_order` | BackupSwitchOrder |  | interval 方式的轮换顺序:seq 按最久未用的顺序;rand 随机。 可选值: ["seq","rand"] |
| `backup_switch_type` | BackupSwitchType |  | 备用 IP 切换方式。master_down = 同一解析线路主 IP 不可用几个就启用几个备用;gt_online_ip = 在线主 IP 数少于备用 IP 数时补齐备用(不超过不可用主 IP 数);interval = 组内全是备用 IP,按间隔轮换(切到 interval 前组内不能有主 IP)。 可选值: ["master_down","gt_online_ip","interval"] |
| `cname_hostname` | string |  | 接入名的主机记录部分(如 www),小写字母/数字/连字符、点分多段;各分组不能重复(409 cname_hostname_taken);新增留空随机生成 8 位,编辑留空保持原值。 |
| `des` | string |  | 备注说明 |
| `name` | string | 有 | 名称 |
| `region_id` | integer |  | 区域 ID |

```sh
curl -X POST "https://panel.example.com/api/v2/node-groups" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/node-groups/{id}`

获取节点分组 · 鉴权: 仅管理员

```sh
curl "https://panel.example.com/api/v2/node-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### PUT `/api/v2/node-groups/{id}`

修改节点分组 · 鉴权: 仅管理员

请求体:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `backup_interval_s` | integer |  | interval 方式的轮换间隔(秒)。 |
| `backup_ip_num` | integer |  | interval 方式每轮在用的备用 IP 数。 |
| `backup_min_online` | integer |  | 组内可用线路少于它就把引用本组的接入名自动切到各自的备用组;0 = 不自动切,缺省 1(可用为 0 即切)。 |
| `backup_switch_order` | BackupSwitchOrder |  | interval 方式的轮换顺序:seq 按最久未用的顺序;rand 随机。 可选值: ["seq","rand"] |
| `backup_switch_type` | BackupSwitchType |  | 备用 IP 切换方式。master_down = 同一解析线路主 IP 不可用几个就启用几个备用;gt_online_ip = 在线主 IP 数少于备用 IP 数时补齐备用(不超过不可用主 IP 数);interval = 组内全是备用 IP,按间隔轮换(切到 interval 前组内不能有主 IP)。 可选值: ["master_down","gt_online_ip","interval"] |
| `cname_hostname` | string |  | 接入名的主机记录部分(如 www),小写字母/数字/连字符、点分多段;各分组不能重复(409 cname_hostname_taken);新增留空随机生成 8 位,编辑留空保持原值。 |
| `des` | string |  | 备注说明 |
| `expected_updated_at` | string |  | 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。备用组自动切换(backup_active)也会改 updated_at。 |
| `name` | string |  | 名称 |
| `region_id` | integer |  | 区域 ID |

```sh
curl -X PUT "https://panel.example.com/api/v2/node-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"backup_min_online":2}'
```

### DELETE `/api/v2/node-groups/{id}`

删除节点分组 · 鉴权: 仅管理员

```sh
curl -X DELETE "https://panel.example.com/api/v2/node-groups/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/node-groups/{id}/cname-domains`

节点分组的接入名 · 鉴权: 仅管理员

查询参数:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `page` | integer |  | 页码,从 1 开始。 默认: 1 |
| `page_size` | integer |  | 每页条数。 默认: 20 |
| `kind` | NodeGroupCnameKind |  | 只列该属主种类的接入名;不传列全部。 可选值: ["package","site","stream"] |
| `q` | string |  | 接入名包含该词即命中(不分大小写)。 |

```sh
curl "https://panel.example.com/api/v2/node-groups/{id}/cname-domains" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/node-groups/{id}/line-coverage`

节点组解析去向 · 鉴权: 仅管理员

查询参数:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `item` | string |  | 选项合并键(取自返回的 options[].key);不传取第一个选项。 |

```sh
curl "https://panel.example.com/api/v2/node-groups/{id}/line-coverage" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/node-groups/{id}/line-options`

节点组线路选项 · 鉴权: 仅管理员

```sh
curl "https://panel.example.com/api/v2/node-groups/{id}/line-options" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

### GET `/api/v2/node-groups/{id}/line-status`

节点组线路降级状态 · 鉴权: 仅管理员

查询参数:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `line` | string | 有 | 统一线路代号,如 default、isp:telecom、isp:telecom:11、pv:3:0。 |

```sh
curl "https://panel.example.com/api/v2/node-groups/{id}/line-status" \
  -H "X-API-Key: $GOCDN_API_KEY"
```

节点分组对象:

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `backup_active` | boolean |  | 已被监控自动切到备用组(可用线路回到阈值后自动切回)。 (只读) |
| `backup_interval_s` | integer |  | interval 方式的轮换间隔(秒)。 |
| `backup_ip_num` | integer |  | interval 方式每轮在用的备用 IP 数。 |
| `backup_min_online` | integer |  | 组内可用线路少于它就把引用本组的接入名自动切到各自的备用组;0 = 不自动切,缺省 1(可用为 0 即切)。 |
| `backup_switch_order` | BackupSwitchOrder |  | interval 方式的轮换顺序:seq 按最久未用的顺序;rand 随机。 可选值: ["seq","rand"] |
| `backup_switch_type` | BackupSwitchType |  | 备用 IP 切换方式。master_down = 同一解析线路主 IP 不可用几个就启用几个备用;gt_online_ip = 在线主 IP 数少于备用 IP 数时补齐备用(不超过不可用主 IP 数);interval = 组内全是备用 IP,按间隔轮换(切到 interval 前组内不能有主 IP)。 可选值: ["master_down","gt_online_ip","interval"] |
| `backup_switched` | string |  | 最近一次自动切换/切回的时刻。 (只读) |
| `cells` | LineCoverageCell[] |  | mode 为 grid 时 279 格(行 31 省 × 列 不分运营商和 8 家运营商),其余为空数组。 |
| `cname_counts` | NodeGroupCnameCounts |  | 主线路组是本组的接入名个数,按属主分类;明细走 GET /node-groups/{id}/cname-domains。 (只读) |
| `cname_hostname` | string |  | 接入名的主机记录部分(如 www),小写字母/数字/连字符、点分多段;各分组不能重复(409 cname_hostname_taken);新增留空随机生成 8 位,编辑留空保持原值。 |
| `created_at` | string |  | 创建时间 (只读) |
| `des` | string |  | 备注说明 |
| `dns_ready` | boolean |  | 已添加 DNS 账号(至少一个);false 时默认线路兜底不会切换。 |
| `domains` | LineOptionDomain[] |  | 组内全部域名(主组或备用组绑定的)。 |
| `expected_updated_at` | string |  | 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。备用组自动切换(backup_active)也会改 updated_at。 |
| `fqdn` | string |  | 接入名(主机记录.根域)。 |
| `id` | integer |  | 记录 ID (只读) |
| `item` | string |  | 本次返回所属的选项 key;组内没有域名为空串。 |
| `items` | LineStatusItem[] |  | 本页条目 |
| `kind` | NodeGroupCnameKind |  | 接入名属主种类:package = 已售套餐共用,site = 网站,stream = 四层转发。 可选值: ["package","site","stream"] |
| `line` | string |  | 查询的统一线路代号。 |
| `mode` | string |  | grid=有 279 格;none=不分线路(Cloudflare);unpulled=还没拉到线路。 可选值: ["grid","none","unpulled"] |
| `name` | string |  | 名称 |
| `node_count` | integer |  | 组里线路引用的不同节点 IP 数。 (只读) |
| `nodes` | LineOptionNode[] |  | 统一线路并集(不含 default 与专有线路)。 |
| `options` | LineCoverageOption[] |  | 节点组下所有线路选项(按合并键合并后的域名组)。 |
| `owner_id` | integer |  | 属主 id(已售套餐、网站或四层转发的 id,按 kind)。 |
| `private` | LinePrivateGroup[] |  | 专有线路,按域名分组;没有专有线路的域名不列。 |
| `pull_err` | string |  | mode 为 unpulled 时的原因:no_credentials(账号没配凭据)、not_pulled(有凭据但还没拉过)或最近一次拉取的报错原文(含凭据解不开,写账号名);其余为空串。 |
| `region_id` | integer |  | 区域 ID |
| `site_count` | integer |  | 生效接入名的主线路组是本组的网站数:网站有自己的接入名看它的线路组,没有看所属已售套餐的共用接入名(两种 CNAME 模式同口径);只算主线路组,不算备用组。 (只读) |
| `stream_count` | integer |  | 生效接入名的主线路组是本组的四层转发数,口径同 site_count。 (只读) |
| `updated_at` | string |  | 更新时间 (只读) |
