监控与自动化 · DomScan 产品

异步 API 批处理 API 参考

将多个受支持的 API 请求加入队列,无需保持客户端连接即可收集结果。

你将获得什么

将多个受支持的 API 请求加入队列,无需保持客户端连接即可收集结果。

异步RESTMCPSDK

适合选择此产品的场景

适用对象

当同一决策需要跨时间、跨列表或跨多个产品执行时使用自动化。

适合选择此产品的场景

需要将最多 100 个支持的 GET 请求加入队列,并在 24 小时保留窗口内获取 JSON 或 CSV 结果时选择。

你将获得什么

将多个受支持的 API 请求加入队列,无需保持客户端连接即可收集结果。

端点

集成前,请查看支持的操作、输入、输出、执行模式和响应限制。

POST /v1/batches 查看 API 参考
GET /v1/batches 查看 API 参考
GET /v1/batches/:job_id 查看 API 参考
GET /v1/batches/:job_id/results 查看 API 参考
DELETE /v1/batches/:job_id 查看 API 参考

积分和身份验证

免费 需要身份验证。有关确切费用和按项计费,请查看操作参考。

操作示例

使用文档化的操作来收集、评估、补充、验证、比较、保护或监测公开证据。

POST /v1/batches

正文参数

参数 类型 必需
requests object[] 必需
webhook object 可选

响应字段

字段 类型
job object
job.id string
job.status string
job.total integer
job.counts object
job.counts.pending integer
job.counts.processing integer
job.counts.succeeded integer
job.counts.failed integer
job.counts.cancelled integer
job.billing object
job.billing.credits_charged integer
job.billing.credits_refunded integer
job.billing.credits_net integer
job.webhook object
job.webhook.configured boolean
job.webhook.status string
job.webhook.attempts integer
job.status_url string
job.results_url string
job.results_csv_url string
job.poll_after_ms integer | null
job.created_at string
job.started_at string | null
job.completed_at string | null
job.cancelled_at string | null
job.updated_at string
job.processing_deadline_at string
job.results_expires_at string

请求示例

curl -X POST "https://domscan.net/v1/batches" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "requests": [
    {
      "path": "/v1/status",
      "query": {
        "domain": "example.com"
      },
      "reference": "customer-42"
    },
    {
      "path": "/v1/dns",
      "query": {
        "domain": "example.org",
        "type": "MX"
      }
    }
  ],
  "webhook": {
    "url": "https://example.com/hooks/domscan",
    "secret": "replace-with-a-private-secret"
  }
}'

响应示例

{
  "job": {
    "id": "string",
    "status": "queued",
    "total": 1,
    "counts": {
      "pending": 1,
      "processing": 1,
      "succeeded": 1,
      "failed": 1,
      "cancelled": 1
    },
    "billing": {
      "credits_charged": 1,
      "credits_refunded": 1,
      "credits_net": 1
    },
    "webhook": {
      "configured": true,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "poll_after_ms": 1,
    "created_at": "2026-04-15T12:00:00Z",
    "started_at": "2026-04-15T12:00:00Z",
    "completed_at": "2026-04-15T12:00:00Z",
    "cancelled_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z",
    "processing_deadline_at": "2026-04-15T12:00:00Z",
    "results_expires_at": "2026-04-15T12:00:00Z"
  }
}

限制和证据边界

异步作业会返回一个标识符,用于轮询状态并在之后获取结果。
批量操作会处理多个受支持的输入,同时保留文档化的逐项结果。
部分表示部分请求项目或组件已完成,而其他项目或组件未完成。
已缓存表示使用了存储的证据;如有新鲜度元数据,请一并查看。

审核日期:2026-08-22

常见问题

在哪里可以找到 异步 API 批处理 的请求和响应参考?

使用 异步 API 批处理 的 API 参考来查看参数、响应字段、示例、状态码和支持的操作模式。

应如何解读 异步 API 批处理 返回的未知或不完整结果?

未知或部分结果表示无法完全确定所请求的证据。在后续决策中保留结果状态、置信度、新鲜度和限制信息。

异步 API 批处理 如何计费?

费用取决于操作和执行模式。有关当前积分费用、身份验证要求和按项规则,请查看端点参考。