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

Update a Synthetic Job

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

Resource URL

PUT /v1/synthetic/schedule/<id>

Request/Response Format

JSON

Example

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

Enable or Disable a Web Monitoring Job

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

アクション

フィールド名

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

userEnabled

true
Web モニタリングジョブを無効にするuserEnabledfalse

Request Parameters

パラメータ名Parameter Type説明(Description)必須リクエスト

id

文字列

合成ジョブのジョブ ID

合成ジョブの一意の識別子。

ジョブ ID を取得するには、以下の手順を実行します。

  1. コントローラにログインし、[User Experience] > [Browser Apps] > [<Application Name> > Jobs.] に移動します。
  2. ジョブ名にカーソルを合わせ、コピーアイコンをクリックしてジョブ ID をコピーします。
はい
version数字

ジョブが更新されるたびに、バージョンの値が 1 倍に増加します。

"version": 5 のジョブは、作成され、その後 4 回更新されることを示します。

×
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なし
userEnabledブールtrue または false
いいえ
systemEnabledブール
ライセンスがなくなると、このフィールドは無効になります。 いいえ
type文字列

いいえ
rate文字列

非対応
  value番号

いいえ
  unit文字列

いいえ
daysOfWeek文字列

いいえ
timeRange文字列

いいえ
timezone文字列

いいえ
description文字列

いいえ
startTime文字列

いいえ
endTime文字列

いいえ
appKey文字列アプリケーションキー

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

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

いいえ
scheduleMode文字列

いいえ
url文字列"null" または監視する URL

監視する URL。

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

いいえ
script文字列

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

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

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

いいえ
  contentType文字列

いいえ
  script文字列

いいえ
  credentialPlaceholders文字列

いいえ
apiMetadata文字列Web 監視ジョブのスクリプトオブジェクト
いいえ
browserCodes文字列

次の Synthetic 内部ブラウザコードを使用します。

  • Chrome:Chrome
  • Internet Explorer:IE11
  • Firefox:Firefox
  • モバイル:Chrome.DeviceEmulation

はい
chromeVersions文字列Chrome ブラウザバージョン 86
はい
locationCodes文字列

各エージェントロケーションの Synthetic 内部ロケーションコード。「Location Codes」を参照してください。


対応
failOnPageErrorブール

なし
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×
state-

いいえ
  lastFireTime文字列

いいえ
nextFireTime文字列

×
projectedUsage-

いいえ
  projectedDailyRuns番号

×
  projectedMonthlyRuns番号

×
performanceCriteria-

いいえ
  retestOnWarningブール

なし
  retestOnCriticalブール

いいえ
  criterion文字列

×
composableConfig-
このパラメータを使用して、以下を構成できます。
  • カスタム再試行
  • 可用性ルール
いいえ
  numBeforeConfirmedError番号0、1、2、3、5、または 10Number of retries×
  resourceErrorDetection-

いいえ
    ignoreWhen-

いいえ
      resourceUrlContains文字列カンマ区切りリストリソース URL のリストいいえ
      resourceMimeType文字列

×
    onlyWhen-

いいえ
      resourceUrlContains文字列カンマ区切りリストリソース URL のリストいいえ
      resourceMimeType文字列

いいえ
created文字列

いいえ
updated文字列

非対応

Response Status Codes

コード

説明

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