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