合成 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": []
}
}
}
}
レスポンス
{
"_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"
}

Request Parameters

パラメータ名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いいえ
description 文字列ジョブ名ジョブの名前あり

appKey

文字列

アプリケーションキー

コントローラからアプリケーションキーを取得できます。

[User Experience] > [Browser Apps] の順にアクセスします。アプリケーションキーは、アプリケーション名の横に表示されます。

あり
url 文字列"null" または監視する URL

監視する URL。

このパラメータを使用する場合、スクリプトの値

あり
script 文字列

"null"

スクリプト化されたジョブがある場合は、ユーザーフローまたは動作のシミュレーションに使用される python ベースの selenium スクリプトを指定します。

このパラメータを使用する場合、url の値

あり
contentType 文字列 "null" or "INLINE_PYTHON_3"

url が

スクリプト "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 内部ロケーションコード。「ロケーションコード」を参照してください。

あり
captureVisualMetrics ブーリアンtrue または false いいえ
simulateMobileBrowser ブーリアンtrue または false いいえ

networkProfile

文字列"name":"Native"、"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、または 10Number of retriesいいえ
resourceErrorDetection -いいえ
ignoreWhen -いいえ
resourceUrlContains 文字列カンマ区切りリストリソース URL のリストいいえ
resourceMimeType 文字列いいえ
onlyWhen -いいえ
resourceUrlContains 文字列カンマ区切りリストリソース URL のリストいいえ
resourceMimeType 文字列いいえ

Location Codes

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

Response Status Codes

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