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

このページでは、合成 Web モニタリングジョブの作成と構成に使用する API について説明します。

Create a Synthetic Job

指定された JSON ペイロードを使用して新しい合成 Web モニタリングジョブを作成します。

Resource URL

POST /v1/synthetic/schedule

Request/Response Format

JSON

Example

{
  "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": []
      }
    }
  }
}

YML

{
  "_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"
}

YML

Request Parameters

パラメータ名	Parameter Type	値	説明（Description)	必須リクエスト
`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	いいえ
`description`	文字列	ジョブ名	ジョブの名前	はい
`appKey`	文字列	アプリケーションキー	コントローラからアプリケーションキーを取得できます。 [User Experience] > [Browser Apps] の順にアクセスします。アプリケーションキーは、アプリケーション名の横に表示されます。	はい
`url`	文字列	`"null"` または監視する URL	監視する URL。このパラメータを使用する場合、`script` パラメータの値は null である必要があります。	はい
`script`	文字列	`"null"` または監視する python ベースの selenium スクリプト	スクリプト化されたジョブがある場合は、ユーザーフローまたは動作のシミュレーションに使用される python ベースの selenium スクリプトを指定します。このパラメータを使用する場合、`url` パラメータの値は null である必要があります。	はい
`contentType`	文字列	`"null" or "INLINE_PYTHON_3"`	`url` 値が null（URL ジョブ）でない場合、コンテンツタイプは null です `script` 値が null（スクリプトジョブ）でない場合、コンテンツタイプは `"INLINE_PYTHON_3"` です	はい
`script`	文字列	`"null" or Python script`	スクリプト化されたジョブ用の Python ベースの Selenium スクリプト	はい
`credentialPlaceholders`	文字列
`apiMetadata`	文字列	Web 監視ジョブのスクリプトオブジェクト		いいえ
`browserCodes`	文字列	次の Synthetic 内部ブラウザコードを使用します。 Chrome：`Chrome` Internet Explorer：`IE11` Firefox：`Firefox` モバイル：`Chrome.DeviceEmulation`		はい
`chromeVersions`	文字列	Chrome ブラウザバージョン 86		はい
`locationCodes`	文字列	各エージェントロケーションの Synthetic 内部ロケーションコード。「Location Codes」を参照してください。		対応
`captureVisualMetrics`	ブール	`true` または `false`		いいえ
`simulateMobileBrowser`	ブール	`true` または `false`		いいえ
`networkProfile`	文字列		「name」：「ネイティブ」、「downloadKbps」：5000、「uploadKbps」：1000、「roundtripTimeMillis」：28、「packetLossPercent」：0、「isDefault」：false	いいえ
`name`	文字列	カスタム、ピクセル、iPad、iPhone SE	デバイスの名前	いいえ
`description`	文字列	名前がカスタムの場合：`User agent` 名前フィールドがカスタムでない場合：`"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	秒	×
`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`	文字列			非対応

Location Codes

クラウドのロケーション	Codes
Azure
アムステルダム	NET
サンアントニオ	SAN
メルボルン	ASV
トロント	CAC
チェンナイ	SIC
AWS
ムンバイ	BOM
ケープタウン	CPT
ダブリン	DUB
フランクフルト	FRA
サンパウロ	GRU
香港	HON
アッシュバーン	IAD
ソウル	ICN
ロンドン	LON
ボードマン	M50
Milan	MIL
モントリオール	MON
東京	NRT
パリ	PAR
サンフランシスコ	SFO
シンガポール	SIN
シドニー	SYD

Response Status Codes

コード	説明
200	成功
401	未認証
402	ジョブの制限を超えました
422	検証の失敗
429	スロットル
500	内部サーバーエラーです