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

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

Create an API Monitoring Job

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

Resource URL

POST /v1/synthetic/api/schedule

Request/Response Format

JSON

Example

リクエスト

JAVASCRIPTCopy

{ "scheduleRunConfigs": [ { "rate": { "value": 15, "unit": "MINUTES" }, "daysOfWeek": [ "SUN", "WED", "THUR", "FRI", "MON", "TUES", "SAT" ], "timezone": "UTC" } ], "description": "jobUI", "apiMetadata": { "script": { "contentType": "JAVASCRIPT", "script": "// Javascript based API Monitoring Test\n\nconst assert = require(\"assert\");\n(async () => {\n var response = await client.get(\"<URL>\");\n assert.equal(response.statusCode, 200);\n assert.equal(response.statusMessage, \"OK\");\n for(var key in response.headers) {\n console.log(`${key} : ${response.headers[key]}`);\n }\n assert.equal(response.body, \"response body\");\n})()" } }, "browserCodes": [ "API" ], "chromeVersions": [], "locationCodes": [ "M50" ], "timeoutSeconds": 15, "appKey": "appKey", "composableConfig": { "numBeforeConfirmedError": 0, "resourceErrorDetection": { "ignoreWhen": { "resourceUrlContains": [], "resourceMimeType": [] }, "onlyWhen": { "resourceUrlContains": [], "resourceMimeType": [] } } }, "performanceCriteria": { "retestOnWarning": false, "retestOnCritical": false, "warningCriterion": [], "criticalCriterion": [] } }

{
"scheduleRunConfigs": [
{
"rate": {
"value": 15,
"unit": "MINUTES"
},
"daysOfWeek": [
"SUN",
"WED",
"THUR",
"FRI",
"MON",
"TUES",
"SAT"
],
"timezone": "UTC"
}
],
"description": "jobUI",
"apiMetadata": {
"script": {
"contentType": "JAVASCRIPT",
"script": "// Javascript based API Monitoring Test\n\nconst assert = require(\"assert\");\n(async () => {\n    var response = await client.get(\"<URL>\");\n    assert.equal(response.statusCode, 200);\n    assert.equal(response.statusMessage, \"OK\");\n    for(var key in response.headers) {\n        console.log(`${key} : ${response.headers[key]}`);\n    }\n    assert.equal(response.body, \"response body\");\n})()"
}
},
"browserCodes": [
"API"
],
"chromeVersions": [],
"locationCodes": [
"M50"
],
"timeoutSeconds": 15,
"appKey": "appKey",
"composableConfig": {
"numBeforeConfirmedError": 0,
"resourceErrorDetection": {
"ignoreWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
},
"onlyWhen": {
"resourceUrlContains": [],
"resourceMimeType": []
}
}
},
"performanceCriteria": {
"retestOnWarning": false,
"retestOnCritical": false,
"warningCriterion": [],
"criticalCriterion": []
}
}

レスポンス

JSONCopy

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

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

Location Codes

Response Status Codes