系统使用说明
给后台操作的人看。业务项目拉域名、上报、种子加解密,看侧栏里的「打开 API 对接文档」。
怎么用这份说明
- 用分配的账号登录。首次安装的默认账号写在登录页上。
- 先在「接入管理」建项目,再在「候选域名」加地址。
- 新加的地址先是备用,不会下发。确认可用后,点「进入省池」。
- 只有池状态是「在池」的省,客户端才能拉到。
候选域名
维护可下发的地址,并决定它进入哪些省。
- 新增域名只建候选,不进省池。地址要写完整的
https://。 - 筛选可以按产品、类型、池状态、域名查。池状态是:备用、在池、出池、待确认。
- 启用这一列是域名开没开。停用或被封禁的不下发,也不进巡检。
- 进入省池用来把备用或已有域名挂进省。可以勾选省,也可以一键全国。
界面上不再填写探活路径。新建时系统按 /health 保存。省池出池仍由本机按这个路径做 HTTP 探活。第三方 Ping 不看路径。
池状态
| 状态 | 会不会下发 | 接下来怎么处理 |
|---|---|---|
| 备用 | 不会 | 还没有省成员。点「进入省池」,或等自动入池补上。 |
| 在池 | 会 | 正在下发。连续失败达到次数后,这些省出池。 |
| 出池 | 不会 | 探活继续打。连续成功后进入待确认,不会自动回到在池。 |
| 待确认 | 不会 | 点「重新入池」。这个域名所有待确认的省一起回到在池。 |
同一个域名可以一部分省在池、一部分出池。筛选「在池」或「出池」时,只要有对应的省就会出现。
备用和自动入池
还没进省的域名就是备用。备用不一定自动入池。
- 新增时的勾选,以及列表上的「已开启 / 未开启」,只表示自动入池。
- 只有「已开启」、启用、没被封禁、还没有省成员的备用,才会用来补位。
- 补位条件:同产品、同类型,有域名从在池出池。待确认再失败、本来就在出池的,不补。
- 一轮里一个域名出了多个省,只取一个备用,补进刚出池的那些省。优先级数字小的先用。
- 补完之后没有下一个备用,或当时就没有备用,给该项目告警群发「没有备用域名,请添加备用域名」。
待确认
候选域名里,池状态是待确认的行,按钮是「重新入池」。确认后,这个域名所有待确认的省一起回到在池并重新下发。不用一个省一个省点。
「域名池」页的待确认列表里,点任意一行的「重新入池」也是整域名通过。在池的省可以按省踢出。已经在池或还是备用的域名,按钮仍是「进入省池」。
其他页面
| 页面 | 用来做什么 |
|---|---|
| 域名池 | 按备用、在池、出池、待确认分开看。只有在池会下发。可用域名筛选。 |
| 接入管理 | 建项目,再生成 API Key。客户端请求带 X-Api-Key,只能访问这个 Key 绑定的产品。 |
| 种子地址 | 先选产品。开发只要钥匙和开机地址。第 3 步填第二站,第 4 步填最终接口,第 5 步把业务域名发布到 S3(域名池被封时 App 走这份)。换钥匙后要再发布一次。 |
| S3 配置 | 每个项目一套桶和密钥。上传环境在这一页选择,整套后台共用:测试是 seeds/test/产品/层级.txt,生产是 seeds/prod/产品/层级.txt,同一个桶不会互相覆盖。点保存后以这里为准。已经写回的旧下载地址,要再上传一次才会换成新路径。填了 CloudFront 域名后,下载地址走这个域名,桶保持私有。 |
| 监控告警 | 每个项目自己的 Telegram 机器人。先保存 Bot Token,把机器人拉进群,在群里发 /chatid,再把数字填回来。两项都空表示这个项目不发告警。 |
| 阈值配置 | 延迟、探测间隔、连续失败出池、连续成功进入待确认。范围越具体越优先:产品 + 类型 + 省,然后产品 + 类型,然后产品,最后全局。 |
| 探测与审计 | 本机 HTTP 探活记录,以及后台操作审计。按项目、省、域名查,每页 20 条。 |
| 巡检记录 | 第三方 Ping 的每轮结果,不发 Telegram。按项目、域名、时间查,每页 20 条,保留 30 天。 |
| 账号 | 全部项目的账号可以管理其他人。限定项目的账号只能看自己的域名、Key、种子和告警。 |
探活和巡检
- 省池出池看本机 HTTP 探活,以及客户端上报。连续失败出池,连续成功只进待确认。
- 巡检记录是第三方 Ping。结论以站长之家 Ping 为准,没有数据时用 17ce。IT 探测网只作补充,不改结论。
- 启用的候选都会进巡检,包括还没入池和已经出池的。停用、被封禁的不进。
- 「立即探测一轮」只跑本机 HTTP 探活,不代替巡检。
和 API 文档的区别
这份是后台操作说明。客户端怎么拉可用域名、怎么上报、种子怎么验签解密,在管理后台侧栏「打开 API 对接文档」,地址是接口上的 /docs/。