Modify a Dial Testing Task¶
POST /api/v1/dialing_task/{task_uuid}/modify
Overview¶
Route Parameters¶
Parameter Name | Type | Required | Description |
---|---|---|---|
task_uuid | string | Y | ID of the dial testing task |
Body Request Parameters¶
Parameter Name | Type | Required | Description |
---|---|---|---|
regions | array | Y | List of regions Allow null: False |
task | json | Y | Task configuration Allow null: False $maxDictLength: 65536 |
task.url | string | URL Allow null: False |
|
task.method | string | Method Allow null: False |
|
task.name | string | Y | Task name Allow null: False Maximum length: 256 |
task.frequency | string | Y | Dial testing frequency Allow null: False Possible values: ['1m', '5m', '15m', '30m', '1h', '6h', '12h', '24h'] |
task.advance_options | json | Advanced options Allow null: False |
|
task.advance_options_headless | json | Browser's advanced options settings Allow null: False |
|
task.success_when_logic | string | Logical relationship within success_when conditions, default is and Allow null: False Possible values: ['and', 'or'] |
|
task.success_when | array | Success_when Allow null: False |
|
task.enable_traceroute | boolean | Traceroute Allow null: False |
|
task.packet_count | integer | Number of pings sent each time Allow null: False |
|
task.host | string | Mandatory parameter when type=tcp/icmp Allow null: False |
|
task.port | string | Mandatory parameter when type=tcp Allow null: False |
|
task.timeout | string | Optional parameter when type=tcp/icmp Allow null: False |
|
task.message | string | Mandatory parameter when type=websocket Allow null: False |
|
task.post_mode | string | Availability judgment mode Default-default Script mode-script Allow null: False |
|
task.post_script | string | Script content Allow null: False Allow empty string: True |
|
tags | array | List of tag names Allow null: False |
Additional Parameter Explanation¶
Data explanation.
Parameter Name | Type | Required | Description |
---|---|---|---|
type | string | Y | Dial testing type, optional options http , tcp , dns , browser , tcp , icmp , websocket |
regions | array | Y | Task execution region |
task | json | Y | Task details |
task.name | string | Y | Task name |
task.url | string | Y | URL |
task.method | string | Y | URL request method |
task.status | string | Y | Task status, possible values ok , stop |
task.frequency | string | Y | Task frequency |
task.advance_options | json | ||
task.success_when_logic | enum | N | Possible values: [and , or ], logical relationship within success_when parameters, default is and |
task.success_when | array | Y/N | Mandatory parameter when type=http, optional when type=browser |
task.enable_traceroute | boolean | N | Optional parameter when type=tcp/icmp |
task.packet_count | integer | N | Optional parameter when type=icmp |
task.host | string | N | Mandatory parameter when type=tcp/icmp |
task.port | string | N | Mandatory parameter when type=tcp |
task.timeout | string | N | Optional parameter when type=tcp/icmp |
task.message | string | Y/N | Mandatory parameter when type=websocket |
task.post_mode | string | N | Availability judgment mode Default-default Script mode-script |
task.post_script | string | N | Availability judgment script content |
tags | array | N | Tag list |
Note: For specific details within the dial testing task parameters, refer to Custom Dial Testing¶
{
"regions": ["us", "singapore"],
"task": {
"url": "http://example.com/some/api",
"method": "POST",
"external_id": "ID defined by external system for this task",
"post_url": "This parameter is provided by Studio backend https://dataway.cn?token=tkn_xxx",
"status": "ok/stop",
"name": "Task naming",
"frequency": "1m",
"regions": "beijing",
"advance_options": {
"request_options": {
"follow_redirect": true,
"headers": {
"header1": "value1",
"header2": "value2"
},
"cookies": "",
"auth": {
"username": "",
"password": ""
}
},
"request_body": {
"body_type": "text/plain|application/json|text/xml",
"body": ""
},
"certificate": {
"ignore_server_certificate_error": false,
"private_key": "",
"certificate": ""
},
"proxy": {
"url": "",
"headers": {
"header1": "value1"
}
}
},
"success_when_logic": "and",
"success_when": [
{
"body": {
"contains": "",
"not_contains": "",
"is": "",
"is_not": "",
"match_regex": "",
"not_match_regex": ""
},
"header": {
"header-name": {
"contains": "",
"not_contains": "",
"is": "",
"is_not": "",
"match_regex": "",
"not_match_regex": ""
},
"another-header-name": "..."
},
"response_time": "100ms",
"status_code": [
{ "is": "200" },
{ "is_not": "400" },
{ "match_regex": "ok*" },
{ "not_match_regex": "*bad" }
]
},
{
"AND_another_assert": "..."
}
]
},
"tags": ["Tag name"]
}
_ Explanation of task.frequency parameter _
The time frequency range for Free Plan workspaces is 30m/1h/6h/12h/24h
Request Example¶
curl 'https://us1-openapi.truewatch.com/api/v1/dialing_task/dial_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"regions":["reg_xxxx20"],"task":{"frequency":"1m","method":"GET","url":"https://www.google.com","name":"test","advance_options":{"request_options":{"follow_redirect":false,"headers":{},"cookies":"","auth":{"username":"","password":""}},"request_body":{"body_type":"","body":""},"secret":{"not_save":false}},"success_when":[{"body":[{"contains":"200"}]}],"success_when_logic":"and"},"tags":["test"]}' \
--compressed
Response¶
{
"code": 200,
"content": {
"createAt": 1686193610,
"creator": "acnt_xxxx32",
"deleteAt": -1,
"id": null,
"regions": [
"reg_xxxx20"
],
"status": 0,
"tagInfo": [
{
"id": "tag_xxxx32",
"name": "test"
}
],
"task": {
"advance_options": {
"request_body": {
"body": "",
"body_type": ""
},
"request_options": {
"auth": {
"password": "",
"username": ""
},
"cookies": "",
"follow_redirect": false,
"headers": {}
},
"secret": {
"not_save": false
}
},
"external_id": "dial_xxxx32",
"frequency": "1m",
"method": "GET",
"name": "test",
"owner_external_id": "wksp_xxxx32",
"post_url": "http://testing-openway.truewatch.com?token=tkn_xxxxx",
"status": "ok",
"tagInfo": [],
"success_when": [
{
"body": [
{
"contains": "200"
}
]
}
],
"success_when_logic": "and",
"url": "https://www.google.com"
},
"type": "http",
"updateAt": 1686193610,
"updator": "acnt_xxxx32",
"uuid": "dial_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "712401530723551303"
}