合成 Web モニタリングジョブの更新 API

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

合成ジョブの更新

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

リソースURL

PUT <api_server_URL>/v1/synthetic/schedule/<id>

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

POST <controller_url>/controller/restui/synthetic/schedule/<applicationId>/updateSchedule

要求/応答の形式

JSON

例（基本認証）

リクエスト

{
"_id": "job_id",
"version": 2,
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"FRI",
"MON",
"THUR",
"SAT",
"TUES"
],
"timezone": "UTC"
}
],
"userEnabled": true,
"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",
"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"
}

レスポンス

{
"_id": "job_id",
"version": 1,
"scheduleRunConfigs": [
{
"rate": {
"value": 1,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC"
}
],
"userEnabled": true,
"systemEnabled": true,
"type": "ALL_BROWSERS",
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC",
"description": "https://appdynamics.com",
"appKey": "appKey",
"scheduleMode": "NONE",
"url": "https://appdynamics.com",
"browserCodes": [
"Chrome"
],
"chromeVersions": [
"86"
],
"locationCodes": [
"BOM",
"M50"
],
"failOnPageError": true,
"captureVisualMetrics": true,
"simulateMobileBrowser": false,
"networkProfile": {
"name": "Native",
"downloadKbps": 5000,
"uploadKbps": 1000,
"roundtripTimeMillis": 28,
"packetLossPercent": 0,
"isDefault": false
},
"timeoutSeconds": 15,
"state": {
"lastFireTime": "2022-04-06T05:57:16.000Z",
"nextFireTime": "2022-04-06T06:00:16.000Z"
},
"projectedUsage": {
"projectedDailyRuns": 2880,
"projectedMonthlyRuns": 86400
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"criterion": []
},
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"created": "2022-04-05T05:30:36.426Z",
"updated": "2022-04-05T05:30:36.426Z"
}

例（OAuth 認証）

リクエスト

{
"id": "job_id",
"version": 2,
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"FRI",
"MON",
"THUR",
"SAT",
"TUES"
],
"timezone": "UTC"
}
],
"userEnabled": true,
"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",
"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"
}

レスポンス

{
"id": "job_id",
"version": 1,
"scheduleRunConfigs": [
{
"rate": {
"value": 1,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC"
}
],
"userEnabled": true,
"systemEnabled": true,
"type": "ALL_BROWSERS",
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"WED",
"FRI",
"SUN",
"SAT",
"TUES",
"MON",
"THUR"
],
"timezone": "UTC",
"description": "https://appdynamics.com",
"appKey": "appKey",
"scheduleMode": "NONE",
"url": "https://appdynamics.com",
"browserCodes": [
"Chrome"
],
"chromeVersions": [
"86"
],
"locationCodes": [
"BOM",
"M50"
],
"failOnPageError": true,
"captureVisualMetrics": true,
"simulateMobileBrowser": false,
"networkProfile": {
"name": "Native",
"downloadKbps": 5000,
"uploadKbps": 1000,
"roundtripTimeMillis": 28,
"packetLossPercent": 0,
"isDefault": false
},
"timeoutSeconds": 15,
"state": {
"lastFireTime": "2022-04-06T05:57:16.000Z",
"nextFireTime": "2022-04-06T06:00:16.000Z"
},
"projectedUsage": {
"projectedDailyRuns": 2880,
"projectedMonthlyRuns": 86400
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"criterion": []
},
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"created": "2022-04-05T05:30:36.426Z",
"updated": "2022-04-05T05:30:36.426Z"
}

Web モニタリングジョブを有効または無効にする

次の値を更新することで、Web モニタリングジョブを有効または無効にすることができます。



Web モニタリングジョブを有効にする	ユーザー有効	true
Web モニタリングジョブを無効にする	`ユーザー有効`	false

リクエストパラメータ


パラメータ名	Parameter Type	値	説明	必須リクエスト
id	文字列	合成ジョブのジョブ ID	合成ジョブの一意の識別子。ジョブ ID を取得するには、以下の手順を実行します。コントローラにログインし、[User Experience]>[Browser Apps]> `<アプリケーション名> >[Jobs] に移動します。` ジョブ名にカーソルを合わせ、コピーアイコンをクリックしてジョブ ID をコピーします。	あり
version	数		ジョブが更新されるたびに、バージョンの値が 1 倍に増加します。 "version" があるジョブ：	いいえ
`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	いいえ
`ユーザー有効`	ブーリアン	`true` または `false`		いいえ
`systemEnabled`	ブーリアン		ライセンスがなくなると、このフィールドは無効になります。	いいえ
`type`	文字列			いいえ
`rate`	文字列			いいえ
`value`	数字			いいえ
`unit`	文字列			いいえ
`daysOfWeek`	文字列			いいえ
`timeRange`	文字列			いいえ
`timezone`	文字列			いいえ
`説明`	文字列			いいえ
`startTime`	文字列			いいえ
`endTime`	文字列			いいえ
`appKey`	文字列	アプリケーションキー	コントローラからアプリケーションキーを取得できます。 [User Experience]>[Browser Apps] に移動します。アプリケーションキーは、アプリケーション名の横に表示されます。	いいえ
`scheduleMode`	文字列			いいえ
`url`	文字列	`"null"` または監視する URL	監視する URL。このパラメータを使用する場合、スクリプトの値	いいえ
`スクリプト`	文字列	"null"	スクリプト化されたジョブがある場合は、ユーザーフローまたは動作のシミュレーションに使用される python ベースの selenium スクリプトを指定します。このパラメータを使用する場合、url の値	いいえ
`contentType`	文字列			いいえ
`スクリプト`	文字列			いいえ
`credentialPlaceholders`	文字列			いいえ
`apiMetadata`	文字列	Web モニタリングジョブのスクリプトオブジェクト		いいえ
`browserCodes`	文字列	次の Synthetic 内部ブラウザコードを使用します。 Chrome：`Chrome` Internet Explorer：`IE11` Firefox：`Firefox` モバイル：`Chrome.DeviceEmulation`		あり
`chromeVersions`	文字列	Chrome ブラウザバージョン 86		あり
`locationCodes`	文字列	各エージェントロケーションの Synthetic 内部ロケーションコード。「ロケーションコード」を参照してください。		あり
`failOnPageError`	ブーリアン			いいえ
`captureVisualMetrics`	ブーリアン	`true` または `false`		いいえ
`simulateMobileBrowser`	ブーリアン	`true` または `false`		いいえ
networkProfile	文字列		"name"："Native"、"downloadKbps"：5000、"uploadKbps"：1000、"roundtripTimeMillis"：28、"packetLossPercent"：0、"isDefault"：false	いいえ
name	文字列	カスタム、ピクセル、iPad、iPhone SE	デバイスの名前	いいえ
description	文字列	名前が「カスタム」の場合：ユーザーエージェント名前フィールドが「カスタム」でない場合："null"	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	秒	いいえ
`state`	-			いいえ
`lastFireTime`	文字列			いいえ
`nextFireTime`	文字列			いいえ
`projectedUsage`	-			いいえ
`projectedDailyRuns`	数字			いいえ
`projectedMonthlyRuns`	数字			いいえ
`performanceCriteria`	-			いいえ
`retestOnWarning`	ブーリアン			いいえ
`retestOnCritical`	ブーリアン			いいえ
`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	内部サーバーエラーです