複数の合成 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。

このパラメータを使用する場合、script パラメータの値は null である必要があります。

あり
スクリプト 文字列

"null" または監視する python ベースの selenium スクリプト

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

このパラメータを使用する場合、url パラメータの値は null である必要があります。

あり
contentType 文字列 "null" または "INLINE_PYTHON_3"

url 値が null(URL ジョブ)でない場合、コンテンツタイプは null です

script 値が null(スクリプトジョブ)でない場合、コンテンツタイプは "INLINE_PYTHON_3" です

あり
スクリプト 文字列 "null" または Python スクリプト スクリプト化されたジョブ用の 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デバイスの名前いいえ

説明

文字列

名前が「カスタム」の場合:ユーザーエージェント

名前フィールドが「カスタム」でない場合:"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 文字列いいえ

応答ステータスコード

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