すべての合成 Web モニタリングジョブを取得する API

このページでは、すべての合成 Web モニタリングジョブの構成データを取得するために使用される API について説明します。

合成ジョブの検索

指定された JSON ペイロードで合成ジョブを検索します。

リソースURL

GET <api_server_URL>/v1/synthetic/schedule

または、OAuth 認証方式を使用している場合は、次の URL を使用します。

GET <controller_url>/controller/restui/synthetic/schedule/<applicationId>/getSchedules

応答形式

JSON

例

{
"_first": null,
"_previous": null,
"_next": "52852985-fsdfdsg-23593259",
"_last": null,
"_items": [
{
"_id": "job_id",
"version": 2,
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"FRI",
"MON",
"THUR",
"SAT",
"TUES"
],
"timezone": "UTC"
}
],
"userEnabled": false,
"systemEnabled": true,
"type": "ALL_BROWSERS",
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"FRI",
"MON",
"THUR",
"SAT",
"TUES"
],
"timezone": "UTC",
"description": "appd1",
"appKey": "appKey",
"scheduleMode": "NONE",
"script": {
"contentType": "INLINE_PYTHON_3",
"script": "pageUrl = \"http://www.appdynamics.com\"\ndriver.get(pageUrl)\nassert \"AppDynamics\" in driver.title, \"Title should contain AppDynamics\""
},
"browserCodes": [
"Chrome"
],
"chromeVersions": [
"86"
],
"locationCodes": [
"M50"
],
"failOnPageError": true,
"captureVisualMetrics": true,
"simulateMobileBrowser": false,
"networkProfile": {
"name": "Native",
"description": "",
"downloadKbps": 5000,
"uploadKbps": 1000,
"roundtripTimeMillis": 28,
"packetLossPercent": 0,
"isDefault": false
},
"timeoutSeconds": 30,
"state": {
"lastFireTime": "2022-04-01T04:49:46.544Z"
},
"projectedUsage": {
"projectedDailyRuns": 96,
"projectedMonthlyRuns": 2880
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"criterion": []
},
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"created": "2022-04-01T04:49:46.538Z",
"updated": "2022-04-01T04:50:13.325Z"
}
]
}

リクエスト パラメータ

パラメータ名Parameter Type値説明必須リクエスト

appKey

クエリ

アプリケーションキー

特定のアプリケーションの Web モニタリングジョブを取得します。いいえ
説明クエリジョブ名

ジョブ名を使用してジョブを検索します。

このパラメータは、次の場合にすべてのジョブを取得します。

  • ジョブ名が文字列に等しい

または

  • ジョブ名に、文字列と等しい部分文字列が含まれる
注: すべての文字列一致操作では、大文字と小文字が区別されません。
いいえ
locationクエリ各エージェントロケーションの Synthetic 内部ロケーションコード

指定されたロケーションのみにスケジュールされた Web モニタリングジョブを取得します。

このパラメータを複数回指定して、複数のロケーションのジョブをフィルタリングできます。

いいえ
ブラウザクエリSynthetic 内部ブラウザコード

指定されたブラウザのみにスケジュールされた Web モニタリングジョブを取得します。

このパラメータを複数回指定して、複数のブラウザのジョブをフィルタリングできます。

いいえ

最大

クエリ

1 ～ 100 の整数

このパラメータを使用して、結果をページ分割された形式で表示できます。

ページに表示される結果の最大数は、このパラメータの値と同じです。

さらに結果がある場合は、応答に _next カーソルが表示されます。この値を使用して、次の結果セットを取得します。

いいえ

カーソル

クエリ

_next の値

このパラメータは、max パラメータが用いられている場合にのみ使用できます。

結果をページ分割された形式で表示し、結果が 1 ページを超える場合、前の応答の _next パラメータの値が次の要求で使用されます。

いいえ

応答ステータスコード

200成功
401Unauthorized
429スロットル
500内部サーバーエラーです