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

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

Create a Synthetic Job

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

Resource URL

POST /v1/synthetic/schedule

Request/Response Format

JSON

Example

リクエスト
JSON
{
"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": []
}
}
}
}
レスポンス
JSON
{
"_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、または 10 Number 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
Milan MIL
モントリオール MON
東京 NRT
パリ PAR
サンフランシスコ SFO
シンガポール SIN
シドニー SYD

Response Status Codes

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