入门
错误
错误以 JSON 返回,附带可用于匹配的固定错误码。
错误格式
- errorstring
可用于匹配的固定错误码。
- messagestring
可读的说明。
- detailsobject
仅限批量 400:无效的输入。
{
"error": "invalid_ip",
"message": "Invalid IP address format"
}状态码
- 400bad_request, invalid_ip, reserved_ip, invalid_domain, invalid_target, unresolved_host, unknown_jurisdiction, invalid_asn
请求或某项输入无效。
- 401missing_api_key, invalid_api_key, unauthorized
API 密钥缺失或无效。
- 403account_suspended
账户已被暂停。
- 404not_found
该路径或 id 不存在。
- 413too_many_lines
请求体或列表过大。
- 429rate_limit_exceeded
速率限制已用尽。
- 500server_error
我们这边出现故障;请稍后重试。
SDK 中的错误
- APIError
任何错误响应,包含 status、code 和 message。
- AuthenticationError
401 或 403。
- NotFoundError
404。
- RateLimitError
429,包含 reason、retryAfter 和升级链接。
- ConnectionError
未收到响应,包括超时。
import IPScanner, { APIError, RateLimitError } from '@ipscanner.io/sdk';
const client = new IPScanner({ apiKey: 'YOUR_API_KEY' });
try {
await client.ip.lookup('8.8.8.8');
} catch (err) {
if (err instanceof RateLimitError) {
console.log(err.reason, err.retryAfter, err.upgradeUrl);
} else if (err instanceof APIError) {
console.log(err.status, err.code, err.message);
} else {
throw err;
}
}