适用场景Whois域名查询API用于获取域名的准备信息包括准备商、准备时间、到期时间、DNS服务器、域名状态等。常见场景包括域名到期监控对即将过期的域名发出告警expiring_soon字段。域名可用性检测快速判断域名是否已被准备is_available字段。域名准备信息审计获取准备人、准备商等用于合规或尽职调查。域龄分析通过creation_age_text了解域名的准备时长。接口能力边界该接口支持几乎所有ICANN认证的顶级域.com/.cn/.net等具备以下特性自动归一化传入https://www.baidu.com/abc会自动剥离为baidu.com。域名可用性检测未准备域名返回is_availabletrue。到期告警30天内到期返回expiring_soontrue。域龄展示creation_age_text返回“N年M月”可读字符串。国内.cn主体中文上游whoiscx对国内域名返回中文准备主体名。缓存24h同一域名数据24小时内只调一次上游避免重复请求。QPS限制5次/秒。注意该API不提供实时whois查询数据依赖上游缓存时效性约24小时。参数与鉴权请求地址GET https://v1.apizero.cn/api/whoisQuery参数参数名类型必需说明示例domainstring是待查询域名自动归一化baidu.comwith_rawboolean否是否返回原始whois文本默认falsefalse鉴权方式通过HTTP Header传递API KeyX-API-Key: YOUR_API_KEYAPI Key需从服务商获取文档链接见参考文档。每次请求必须携带有效Key否则返回鉴权错误。接入示例curl最简请求curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY \ https://v1.apizero.cn/api/whois?domainbaidu.com带原始whois文本的请求curl -sS \ -X GET \ -H X-API-Key: YOUR_API_KEY \ https://v1.apizero.cn/api/whois?domainbaidu.comwith_rawtrue注意请将YOUR_API_KEY替换为实际Key。返回值解读成功响应示例JSON{ code: 0, msg: 成功, request_id: abc123def456, data: { domain: baidu.com, suffix: com, creation_time: 1999-10-11 19:05:17, expiration_time: 2028-10-11 19:05:17, creation_age_text: 26 年 7 个月, creation_days: 9704, expiring_soon: false, is_available: false, is_expired: false, valid_days: 888, domain_status: [ clientDeleteProhibited 注册商设置禁止删除, clientTransferProhibited 注册商设置禁止转移 ], name_servers: [ NS1.BAIDU.COM, NS2.BAIDU.COM, NS3.BAIDU.COM ], registrar: MarkMonitor Information Technology (Shanghai) Co., Ltd., registrar_url: http://markmonitor.com, registrar_abuse_email: abusecomplaintsmarkmonitor.com, registrar_abuse_phone: 1.2083895740, whois_server: whois.markmonitor.com, registrant: , registrant_email: , dnssec: unsigned, query_time: 2026-05-07 09:18:54 } }关键字段说明code业务状态码0表示成功非0表示失败。msg状态描述。request_id请求唯一标识可用于日志追踪。data.is_available域名是否未准备可准备。data.expiring_soon域名是否在30天内到期。data.domain_status域名状态列表如clientTransferProhibited。data.registrant准备人部分域名可能为空。data.whois_server上游whois服务器。常见错误与排错1. 鉴权失败401/403表现返回{code: 1001, msg: Unauthorized}或类似。原因API Key缺失、错误或已过期。排查确认请求Header中包含X-API-Key且值为正确Key。检查环境变量中Key是否未设置。联系服务商确认Key状态。2. 参数domain缺失或为空表现返回{code: 400, error: domain is required}注意错误字段为error而非message。原因未提供domain参数或值为空。排查确保URL中?domain后跟有效域名。使用URL编码处理域名中的特殊字符如中文域名需转换为punycode。3. 域名格式非法或无效TLD表现返回{code: 400, error: invalid domain format}或“unsupported TLD”。原因域名格式错误或顶级域不被支持。排查检查域名是否正确如缺少点、包含空格。确认顶级域在支持列表中主流TLD基本覆盖。使用自动归一化特性传入完整URL也会被处理但若域名本身非法则报错。4. 上游超时或数据不可用表现返回{code: 500, error: upstream timeout}或“service unavailable”。原因上游whois服务器响应慢或拒绝连接。排查重试几次可能临时故障。检查域名是否特殊如新顶级域可能不被上游支持。避免短时间内大量重复查询注意QPS限制。5. 错误响应字段陷阱重要关键问题该API的错误响应字段是error而不是常见的message。如果你在代码中统一用response.data.message捕获错误信息将永远拿不到实际错误描述导致排错困难。示例// 正确的错误响应结构 { code: 400, error: domain is required }建议在解析响应时同时检查error和msg字段优先取errorerror_msg response.get(error) or response.get(msg)6. 缓存导致的“数据陈旧”表现刚准备的域名查询仍返回is_availabletrue或刚过期的域名仍显示未过期。原因API缓存24小时数据非实时。排查理解缓存机制若需要最新数据需等待缓存过期或自身维护状态。不要将whois状态作为实时依据如域名抢注需另外确认。7. QPS限流429表现返回{code: 429, error: Too Many Requests}。原因请求频率超过5次/秒。排查引入节流throttle或队列控制请求速率。批量查询时增加间隔至少200ms一个请求。8. 自动归一化副作用说明传入主域子域如www.baidu.com会被自动剥离为baidu.com返回的是主域的数据。如果需要子域whois需要确认接口是否支持当前仅支持主域。这可能导致预期与结果不符。工程化注意事项错误处理使用try-catch包裹HTTP请求解析JSON时考虑非JSON响应如网关错误。重试策略对5xx错误采用指数退避重试最多3次对4xx错误直接记录日志。字段兼容未来API升级可能增加字段代码应忽略未知字段。安全性API Key不要硬编码在代码中通过环境变量或配置服务注入。日志记录记录request_id以便排查问题。参考文档定期查看官方文档更新。参考文档Whois域名查询API文档原始文档
