合成 API モニタリングジョブの更新 API

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

合成 API モニタリングジョブの更新

指定された JSON ペイロードで API モニタリングジョブを更新します。

リソースURL

PUT <api_server_URL>/v1/synthetic/api/schedule/<id>

または、OAuth 認証方式を使用している場合は、次の URL を使用します。

POST <controller_url>/controller/restui/synthetic/api-schedule/{applicationId}/updateSchedule

要求/応答の形式

JSON

例（基本認証）

リクエスト
{
"_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"
}
レスポンス
{
"_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"
}

例（OAuth 認証）

リクエスト
{
"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"
}
レスポンス
{
"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"
}

API モニタリングジョブを有効または無効にする

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

アクションフィールド名値

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

ユーザー有効

true
API モニタリングジョブを無効にする ユーザー有効 false

応答パラメータ

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

id

文字列

API モニタリングジョブのジョブ ID

API モニタリングジョブの一意の識別子。

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

  1. コントローラにログインし、[User Experience] > [API Monitoring] > <コレクション名> > [Jobs] に移動します。
  2. ジョブ名にカーソルを合わせ、コピーアイコンをクリックしてジョブまたはスケジュール ID をコピーします。
あり
version数

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

"version" があるジョブ：

いいえ
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いいえ
ユーザー有効 ブーリアンtrue または false いいえ
systemEnabled ブーリアンライセンスがなくなると、このフィールドは無効になります。いいえ
type 文字列いいえ
rate 文字列いいえ
value 数字いいえ
unit 文字列いいえ
daysOfWeek 文字列いいえ
timeRange 文字列いいえ
timezone 文字列いいえ
説明 文字列いいえ
startTime 文字列いいえ
endTime 文字列いいえ
appKey 文字列アプリケーションキー

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

  1. [User Experience] > [API Monitoring] に移動します。
  2. コレクション名にカーソルを合わせ、コピーアイコンをクリックしてコレクションキーをコピーします。コレクションキーはアプリケーションキーです。
いいえ
scheduleMode 文字列いいえ
url 文字列"null" または監視する URL

監視する URL。

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

いいえ
スクリプト 文字列

"null"

スクリプト化されたジョブがある場合は、ユーザーフローまたは動作のシミュレーションに使用される 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 内部ロケーションコード。「ロケーションコード」を参照してください。

あり
failOnPageError ブーリアンいいえ
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秒いいえ
state -いいえ
lastFireTime 文字列いいえ
nextFireTime 文字列いいえ
projectedUsage -いいえ
projectedDailyRuns 数字いいえ
projectedMonthlyRuns 数字いいえ
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内部サーバーエラーです