複数の合成 Web モニタリングジョブの作成 API
このページでは、単一の API リクエストを使用して複数の合成 Web モニタリングジョブを作成するために使用される API について説明します。
複数の合成ジョブの作成
指定された JSON ペイロードで複数の合成ジョブを作成します。
リソースURL
POST <api_server_URL>/v1/synthetic/schedule/batch
要求/応答の形式
JSON
例
- リクエスト
{ "schedules": [ { "scheduleRunConfigs": [ { "rate": { "value": 15, "unit": "MINUTES" }, "daysOfWeek": [ "SUN", "WED", "FRI", "MON", "THUR", "SAT", "TUES" ], "timezone": "UTC" } ], "description": "appd1", "appKey": "appKey", "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" ], "captureVisualMetrics": true, "simulateMobileBrowser": false, "networkProfile": { "name": "Native", "downloadKbps": 5000, "uploadKbps": 1000, "roundtripTimeMillis": 28, "packetLossPercent": 0, "isDefault": false }, "timeoutSeconds": 30, "performanceCriteria": { "retestOnWarning": false, "retestOnCritical": false, "criterion": [] }, "composableConfig": { "numBeforeConfirmedError": 0, "resourceErrorDetection": { "ignoreWhen": { "resourceUrlContains": [], "resourceMimeType": [] }, "onlyWhen": { "resourceUrlContains": [], "resourceMimeType": [] } } } } ] }- レスポンス
[ { "status": "200", "errorMessage": "null", "scheduleId": "ID" }, { "status": "422", "errorMessage": "timeout field value exceeds range", "scheduleId": "null" } ]
リクエスト パラメータ
| パラメータ名 | Parameter Type | 値 | 説明 | 必須リクエスト |
|---|---|---|---|---|
scheduleRunConfigs | - | いいえ | ||
rate | - | いいえ | ||
value | 数 | 分:1 ~ 60 時間:1 ~ 24 日:「ヌル」 | いいえ | |
unit | 文字列 | 分、時間、または日 | いいえ | |
daysOfWeek | 文字列 | "SUN"、"MON"、"TUES"、"WED"、"THUR"、"FRI"、"SAT" | いいえ | |
timeRange | 文字列 | hh:mm AM/PM から hh:mm AM/PM まで | いいえ | |
timezone | 文字列 | "UTC" | GMT +/-hh:mm | いいえ |
startTime | 文字列 | dd/mm/yyyy hh:mm AM/PM | いいえ | |
endTime | 文字列 | dd/mm/yyyy hh:mm AM/PM | いいえ | |
説明 | 文字列 | ジョブ名 | ジョブの名前 | あり |
appKey | 文字列 | アプリケーションキー | コントローラからアプリケーションキーを取得できます。 [User Experience]>[Browser Apps] に移動します。アプリケーションキーは、アプリケーション名の横に表示されます。 | あり |
url | 文字列 | "null" または監視する URL | 監視する URL。 このパラメータを使用する場合、 | あり |
スクリプト | 文字列 | | スクリプト化されたジョブがある場合は、ユーザーフローまたは動作のシミュレーションに使用される python ベースの selenium スクリプトを指定します。 このパラメータを使用する場合、 | あり |
contentType | 文字列 | "null" または "INLINE_PYTHON_3" |
| あり |
スクリプト | 文字列 | "null" または Python スクリプト | スクリプト化されたジョブ用の Python ベースの Selenium スクリプト | あり |
credentialPlaceholders | 文字列 | あり | ||
apiMetadata | 文字列 | Web モニタリングジョブのスクリプトオブジェクト | いいえ | |
browserCodes | 文字列 | 次の Synthetic 内部ブラウザコードを使用します。
| あり | |
chromeVersions | 文字列 | Chrome ブラウザバージョン 86 | あり | |
locationCodes | 文字列 | 各エージェントロケーションの Synthetic 内部ロケーションコード。「ロケーションコード」を参照してください。 | あり | |
captureVisualMetrics | ブーリアン | true または false | いいえ | |
simulateMobileBrowser | ブーリアン | true または false | いいえ | |
networkProfile | 文字列 | "name":"Native"、"downloadKbps":5000、"uploadKbps":1000、"roundtripTimeMillis":28、"packetLossPercent":0、"isDefault":false | いいえ | |
name | 文字列 | カスタム、ピクセル、iPad、iPhone SE | デバイスの名前 | いいえ |
説明 | 文字列 | 名前が「カスタム」の場合: 名前フィールドが「カスタム」でない場合: | Mozilla/5.0(Linux、Android 7.0、SAMSUNG SM-G950F Build/NRD90M)AppleWebKit/537.36(KHTML、例:Gecko)SamsungBrowser/5.2 Chrome/51.0.2704.106 Mobile Safari/537.36 | いいえ |
downloadKbps | 数字 | 数字 | ダウンロード帯域幅(kbps 単位) | いいえ |
uploadKbps | 数字 | 数字 | アップロード帯域幅(kbps 単位) | いいえ |
roundtripTimeMillis | 数字 | 数字 | 遅延時間(ミリ秒単位) | いいえ |
packetLossPercent | 数字 | 0~100 | パケット損失率 | いいえ |
isDefault | ブーリアン | true または false | いいえ | |
timeoutSeconds | 数字 | 5 ~ 300 | 秒 | いいえ |
performanceCriteria | - | いいえ | ||
retestOnWarning | ブーリアン | true または false | 警告イベントで再テスト | いいえ |
retestOnCritical | ブーリアン | true または false | 重大なイベントで再テスト | いいえ |
criterion | 文字列 | いいえ | ||
composableConfig | - | このパラメータを使用して、以下を構成できます。
| いいえ | |
numBeforeConfirmedError | 数字 | 0、1、2、3、5、または 10 | Number of retries | いいえ |
resourceErrorDetection | - | いいえ | ||
ignoreWhen | - | いいえ | ||
resourceUrlContains | 文字列 | カンマ区切りリスト | リソース URL のリスト | いいえ |
resourceMimeType | 文字列 | いいえ | ||
onlyWhen | - | いいえ | ||
resourceUrlContains | 文字列 | カンマ区切りリスト | リソース URL のリスト | いいえ |
resourceMimeType | 文字列 | いいえ |
応答ステータスコード
| コード | 説明 |
|---|---|
| 200 | 成功 |
| 401 | Unauthorized |
| 402 | ジョブの制限を超えました |
| 422 | 検証の失敗 |
| 429 | スロットル |
| 500 | 内部サーバーエラーです |