创建拨测任务 - Flashcat API

参数说明：

协议类型：protocol (整数值)

值含义: 0: HTTP 1: ICMP 2: TCP 3: UDP 4: WSDL

关联配置：config

值含义：

follow_redirects: true/false (是否跟随重定向)

insecure_skip_verify: true/false (是否忽略证书校验)

probe_host_percent: 1~100 (拨测机器比例数，用于计算最终参数拨测的机器)

拨测对象： targets 多个拨测对象，用'\n'分隔开 (如: "www.baidu.com\nwww.qq.com")

拨测方法：method (GET 、POST、HEAD）

响应码验证: expect_response_codes (格式: 200 或 2xx 或 2xx|3xx|4xx|5xx)

响应body验证：expect_response_string 根据返回body内容，进行匹配的内容

响应body验证匹配方式： match_pattern

值含义: "complete" 完全匹配 "substring" 部分匹配

拨测周期: period （单位: 秒)

链接超时: connect_timeout (单位: 秒)

10.

任务检测超时: timeout (单位: 秒)

11.

拨测机器: probe_hosts

格式: (机器Ident: 是指在页面上, 数据接入 => 对象列表，表格中"标识"内容)

{"机器Ident1":{"labels":"a=b, c=d"}, "机器Ident2" :{"labels":"w=q"}}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

name

string

必需

description

string

必需

busi_group

integer

必需

labels

string

必需

protocol

integer

必需

method

string

必需

encoding

string

必需

config

object

必需

follow_redirects

boolean

必需

insecure_skip_verify

boolean

必需

probe_host_percent

integer

必需

targetType

integer

必需

targets

string

必需

header

string

必需

body

string

必需

param

string

必需

expect_response_codes

string

必需

match_pattern

string

必需

expect_response_string

string

必需

periodPiece

string

必需

period

integer

必需

timeout

integer

必需

connect_timeout

integer

必需

probe_hosts

object

必需

dev-n9e-01

object

必需

zke-categraf-test

object

必需

示例

{
    "name": "任务测试",
    "description": "",
    "busi_group": 37,
    "labels": "custom=abc,task=probe",
    "protocol": 0,
    "method": "GET",
    "encoding": "utf8",
    "config": {
        "follow_redirects": true,
        "insecure_skip_verify": false,
        "probe_host_percent": 100
    },
    "targets": "http://www.baidu.com",
    "header": "Auth: xx2xx",
    "body": "{}",
    "param": "a=b&c=d",
    "expect_response_codes": "2xx",
    "match_pattern": "substring",
    "expect_response_string": "\"status\": \"ok\"",
    "periodPiece": "second",
    "period": 10,
    "timeout": 10,
    "connect_timeout": 10,
    "probe_hosts": {
        "dev-n9e-01": {
            "labels": "test=host",
        },
        "zke-categraf-test": {
            "labels": "",
            "busi_group": ""
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

错误信息，仅出错时存在

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

request_id

string

请求ID，用于问题追踪

必需

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "request_id": "string"
}