合成 Web モニタリングジョブの実行ステータスを取得する API
このページでは、合成 Web モニタリングジョブの実行ステータスを取得するために使用される API について説明します。
リソースURL
GET <api_server_URL>/v1/synthetic/schedule/<id>/sessions
要求の例:
{{eum_api}}/v1/synthetic/schedule/synthetic-job-schedule-id/sessions?max=20&startTime=1649331373
または、OAuth 認証方式を使用している場合は、次の URL を使用します。
GET <controller_url>/controller/restui/synthetic/schedule/web/<application-id>/<schedule_id>/sessions?max=<maximum_number_ofrecords>&startTime=<timeStamp>&endTime=<timeStamp>
応答本文
応答には、タイムスタンプとステータスの詳細を持つ startTime 以降のセッションのリストが含まれます。
レスポンスの例:
{
"_first": null,
"_previous": null,
"_next": "1648620679",
"_last": null,
"items": [
{
"status": "OK",
"startTime": 1648620679,
"failureType": "None"
},
{
"status": "422",
"startTime": 1648620679,
"failureType": "None"
}
]
}
応答の _next パラメータが null でない場合は、結果がページ分割されていて、さらに結果がある可能性があることを意味します。
さらに結果を取得するには、次のリクエストの startTime として _next の値を使用します。_next パラメータの値が null になるまで、この手順を繰り返します。
リクエスト パラメータ
| パラメータ名 | Parameter Type | 値 | 説明 | 必須リクエスト |
|---|---|---|---|---|
id | パス |
合成ジョブの一意の識別子のパス | 合成ジョブの一意の識別子 | あり |
最大 | クエリ | 1 から 20 の間である必要があります |
ページネーションパラメータ | あり |
startTime | クエリ | セッションを取得する必要がある場所からの開始時間(秒単位のエポックタイム) | ページネーションパラメータ | あり |
endTime | クエリ | エポックタイム(秒単位)、セッションを取得するまでの時間。 | この値が指定されていない場合、現在のタイムスタンプが使用されます。startTime から現在までのセッションの詳細を提供します。 | いいえ |
応答ステータスコード
| ステータス コード | 説明 |
|---|---|
| 200 | 成功 |
| 401 | Unauthorized |
| 429 | スロットル |
| 500 | 内部サーバーエラーです |