モニタリングと自動化 · DomScan製品

非同期 API バッチ APIリファレンス

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。

得られるもの

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。

非同期RESTMCPSDK

この製品を選ぶ場面

対象ユーザー

同じ意思決定を時間をまたいで、リスト全体で、または複数製品にわたって実行する必要があるときに自動化を使います。

この製品を選ぶ場面

対応GETリクエストを最大100件キューに入れ、24時間の保持期間内にJSONまたはCSV結果を取得するときに選びます。

得られるもの

対応する多数の 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 バッチの料金はどのように決まりますか?

料金は操作と実行モードによって異なります。現在のクレジット料金、認証要件、項目ごとのルールについては、エンドポイントリファレンスを確認してください。