即时拨测

更新时间：2024-01-23

探测任务相关

创建探测任务

请求结构

method：POST
URL：/csm/api/v1/site/once/{protocolType}/taskCreate

请求参数

protocolType	String	要创建的协议类型，全大写，可选： HTTP/HTTPS/PING/FTP/TCP/UDP/DNS	是	Path参数
userId	String	用户id	是	RequestBody参数
address	String	探测地址，如：www.baidu.com	是	RequestBody参数
advancedFlag	Boolean	是否开启高级配置，HTTP/HTTPS/TCP适用	否	RequestBody参数
ipType	String	探测点类型： ipv4/ipv6	是	RequestBody参数
idc	String	探测点，可以通过2.1的探测点列表接口获取，多个探测点通过逗号连接，如：beijing-CMNET,beijing-UNICOM	是	RequestBody参数
timeout	int	超时时间	是	RequestBody参数
protocolType	String	要创建的协议类型，全大写，可选：HTTP/HTTPS/PING/FTP/TCP/UDP/DNS。要与请求路径中protocolType一致。	是	RequestBody参数
onceConfig	OnceConfig	普通任务配置	是	RequestBody参数
advancedConfig	AdvancedConfig	高级任务配置	否	RequestBody参数
groupId	String	重新探测创建的任务属于同一个group	否	RequestBody参数
taskType	String	任务类型，目前只支持：NET_QUAILTY （网络质量）	是	RequestBody参数

OnceConfig

名称	类型	描述
anonymousLogin	boolean	是否匿名登录，选填
method	String	HTTP/HTTPS参数，请求方法，必填
postContent	String	HTTP/HTTPS参数， POST请求内容，选填
kidnapWhite	String	DNS参数，DNS劫持白名单，选填
resolveType	String	DNS参数，查询方式，可选：* RECURSION，选填
server	String	DNS参数，DNS服务器，如：114.114.114.114，选填
packetCount	int	Ping参数，Ping发包数，必填
port	int	TCP/UDP/FTP参数，端口号，如：21，必填
inputType	int	UDP参数，输入类型： 1: 文本 2: 十六进制格式 0: 无，选填
input	String	UDP参数，请求内容，选填
outputType	int	UDP参数，输入类型： 1: 文本 2: 十六进制格式 0: 无，选填
expectedOutput	String	UDP参数，期望输出，选填
username	String	FTP参数，用户名，选填
password	String	FTP参数，登陆密码，选填

AdvancedConfig

名称	类型	描述
cookies	String	HTTP/HTTPS参数，请求头中Cookie字段，选填
userAgent	String	HTTP/HTTPS参数，请求头中User-Agent字段，选填
host	String	HTTP/HTTPS参数，请求头中HSOT字段，选填
responseCode	String	HTTP/HTTPS参数，响应码 Code，选填
responseCheck	String	HTTP/HTTPS参数，响应内容匹配，选填
username	String	HTTP/HTTPS参数，验证用户名，选填
password	String	HTTP/HTTPS参数，验证密码，选填
inputType	int	TCP参数，输入类型： 1: 文本 2: 十六进制格式 0: 无，选填
input	String	TCP参数，请求内容，选填
outputType	int	TCP参数，输入类型：1: 文本 2: 十六进制格式 0: 无，选填
expectedOutput	String	TCP参数，期望输出，选填

请求示例

POST /csm/api/v1/site/once/HTTP/taskCreate
{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    // 探测地址
    "address": "www.baidu.com",
    // 是否开启高级配置，HTTP/HTTPS/TCP适用
    "advancedFlag": true,
    // 探测点类型 ipv4/ipv6
    "ipType": "ipv4",
    // 探测点
    "idc": "beijing-CMNET,beijing-UNICOM,beijing-CHINANET,guangdong-CMNET,fujian-CMNET,henan-CMNET,hebei-CHINANET",
    // 超时时间
    "timeout": 60,
    // 协议类型
    // 各协议类型，全大写
    "protocolType": "HTTP",
    // 任务类型
    // NET_QUAILTY  - 网络质量
    "taskType": "NET_QUAILTY",
    "onceConfig": {
        // HTTP/HTTPS
        // 请求方法
        "method": "get",
        // HTTP POST请求内容
        "postContent": "",
        
        // DNS
        // DNS劫持白名单
        "kidnapWhite": "192.168.1.1",
        // 查询方式
        "resolveType": "RECURSION",
        // DNS服务器
        "server": "114.114.114.114",
        
        // PING
        // Ping发包数
        "packetCount": 4,
        
        // TCP/UDP/FTP端口号
        "port": 22,
        
        // UDP
        // UDP请求格式 
        "inputType": 2,
        // UDP请求内容
        "input": "0x11",
        // UDP响应匹配格式
        "outputType": 2,
        // UDP响应内容匹配
        "expectedOutput": "0x11",
        
        // FTP
        // FTP登录名
        "username": "",
        // FTP登陆密码
        "password": ""
    },
    "advancedConfig": {
        // HTTP/HTTPS
        // 请求头中Cookie字段
        "cookies": "auth=abc",
        // 请求头中User-Agent字段
        "userAgent": "os=macOS",
        // 请求头中HSOT字段
        "host": "1.1.1.1",
        // HTTP Code
        "responseCode": "200",
        // 响应内容匹配
        "responseCheck": "success",
        // HTTP验证用户名
        "username": "admin",
        // HTTP验证密码
        "password": "",
        
        // TCP
        // TCP请求格式 
        "inputType": 2,
        // TCP请求内容
        "input": "0x11",
        // TCP响应匹配格式
        "outputType": 2,
        // TCP响应内容匹配
        "expectedOutput": "0x11"
    }
}

// Response
{
    "requestId":"90742375b871445d8907be7748397ef4",
    "success":true,
    "result":{
        // 任务id
        "siteId":"jspjUbhwHVotroGFKeRChlriwxlftkxH",
        // 任务的组id
        "groupId":"be388838-9381-423e-b4ac-afac8dfe70e3"
    },
    "code":200
}

探测历史记录

请求结构

method：POST
URL：/csm/api/v1/site/once/taskList

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	否	RequestBody参数
url	String	探测地址，如：www.baidu.com，直接模糊查询	否	RequestBody参数
pageNo	int	分页数	是	RequestBody参数
pageSize	int	分页大小	是	RequestBody参数
order	String	返回列表的顺序，默认为 desc 降序，还可选 asc 升序	否	RequestBody参数
orderBy	String	排序列表依据的字段，默认为创建时间	否	RequestBody参数
groupId	String	重新探测创建的任务属于同一个group	否	RequestBody参数

请求示例

POST /csm/api/v1/site/once/taskList
{
    // 请求页
    "pageNo":1,
    // 请求页大小
    "pageSize":10,
    // 用户id
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    // 搜索url，支持模糊匹配
    "url": "baidu"
}

// Response
{
    "requestId": "8075cc28167807369286310353357a",
    "code": 200,
    "result": {
        "taskList": [
            {
                // 任务id
                "siteId": "PymZbqvHNJfXRcvSEiBOHmcfBWNAjaDB",
                // 组ID，查询探测历史用
                "groupId":"be388838-9381-423e-b4ac-afac8dfe70e3",
                // 用户
                "userId": "a0d04d7c202140cb80155ff7b6752ce4",
                // 任务类型，目前只有网络质量
                // NET_QUALITY   - 网络质量
                "taskType": "NET_QUALITY",
                // 协议类型
                "protocolType": "HTTP",
                // 探测地址
                "url": "www.baidu.com",
                // 任务的探测点总数
                "agentNum": 7,
                // 返回结果探测点总数
                "sumSampleNum": 7,
                // 整体可用率，统计所有探测点计算
                "success": 100,
                // 探测时间 ，探测结果完成的时间
                "monitorTime": "2023-03-06 10:40:14",
                // 创建时间
                "createTime": "2023-03-06 10:40:14",
                // 任务状态
                // PROBING  - 探测中
                // FINISH   - 已完成
                // FAILED   - 探测失败
                "status": "FINISH"
            }
        ],
        // 当前页
        "pageNo": 1,
        // 页大小
        "pageSize": 10,
        // 总记录数
        "totalCount": 1
    },
    "success": true,
    "message": "success"
}

删除探测记录

请求结构

method：POST
URL：/csm/api/v1/site/once/taskDelete

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	RequestBody参数
siteId	String	探测任务id	是	RequestBody参数

请求示例

POST /csm/api/v1/site/once/taskDelete
{
      // 用户id
    "userId":"453bf9588c9e488f9ba2c984129090dc",
    // 探测任务id
    "siteId":"vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr"
}

// Response
{
    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
    "message": "",
    "success": true,
    "result": {
        "siteId": "vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr",  // 被删除的任务id 
        "groupId": "d13f2b4a-1892-44cb-a3f4-0c7ede23826d" 
    },
    "code": 200
}

探测任务结果

请求结构

method：POST
URL： /csm/api/v1/site/once/loadData

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	RequestBody参数
siteId	String	任务ID	是	RequestBody参数
pageNo	int	分页数	是	RequestBody参数
pageSize	int	分页大小	是	RequestBody参数
order	String	asc/desc	否	RequestBody参数
orderBy	String	排序字段，只能传对应协议类型的指标名	否	RequestBody参数
filterArea	String	按省市过滤探测结果，优先级更高，和filterIsp二选一	否	RequestBody参数
filterIsp	String	按运营商过滤探测结果，和area只能传一个	否	RequestBody参数

请求示例

 POST /csm/api/v1/site/once/loadData
{
    // 请求页
    "pageNo":1,
    // 请求页大小
    "pageSize":10,
    // 按省市过滤探测结果，优先级更高
    "filterArea": "beijing",
 
    // 用户id
    "userId":"453bf9588c9e488f9ba2c984129090dc",
    // 探测任务id
    "siteId":"vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr"
}

// Response
{
    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
    "code": 200,
    "result": {
        // 探测点总数
        "totalNum": 1,
        // 页
        "pageNo": 1,
        // 页大小
        "pageSize": 10,
        // 排序方式
        "order": "desc",
        // 排序字段
        "orderBy": "monitorTime",
        // 任务状态 
        // PROBING  - 探测中
        // FINISH   - 已完成
        // FAILED   - 已失败
        "status": "FINISH",
        // 协议类型
        "protocolType": "HTTP",
        // 探测地址
        "url": "www.baidu.com",
        // 任务类型
        // NET_QUALITY  - 网络质量
        "taskType": "NET_QUALITY",
         // 按省市过滤探测结果，优先级更高
        "filterArea": "beijing",
        // 按运营商过滤探测结果，和area只能传一个
        "filterIsp": "CMNET",
        // 站点任务id
        "siteId": "id",
        // nmp侧任务id
        "jobId": "id",
        // 任务组id
        "groupId": "id",
        // 用户id
        "userId": "id",
        // 任务类型指标名，顺序固定
        "metricOrder": [
            "totalTime",
            "dnsTime",
            "dnsKidnap"
        ],
        // 省市集合
        "allAreas": [
            "hebei",
            "tianjin",
            "hubei",
            "beijing",
            "fujian"
        ],
        // 指标概览
        "overviewData": {
            // 指标部分只会返回该任务协议类型拥有的
            "metrics": {
                // 建连时间
                "connectTime": 17.2,
                // dns解析事件
                "dnsTime": 0.005
            },
            // 可用率
            "success": 89,
            // 采集点总数
            "sumSampleNum": 7,
            // 成功数
            "rightSampleNum": 7,
            // 失败数
            "errSampleNum": 0
        },
        // 探测详情, 探测点列表
        "detailData": [
            {
                // 探测点数据id
                "id": 123,
                // 地域
                "agentProv": "shanghai",
                // 运营商
                "agentIsp": "CHINANET",
                // 探测端的id
                "clientId": "122.137.20.16.1",
                // 探测端城市
                "clientCity" : "上海",
                // 解析结果ip
                "remoteAddr": "220.181.38.150",
                 // 解析结果ip所在地
                "remoteCity": "保定",
                // 解析结果ip所在省
                "remoteArea":"河北",
                // 解析结果ip所在县/区
                "remoteCounty":"顺平",
                // 协议类型 ipv4/ipv6
                "ipProtocol": "ipv4",
                // 任务url
                "url": "www.baidu.com",
                // dns解析结果
                "analysisResult": [
                    "112.53.42.114",
                    "112.53.42.52",
                    "2402:4e00:1020:1404:0:9227:71a3:83d2",
                    "2402:4e00:1020:1404:0:9227:71ab:2b74",
                    "ins-r23tsuuf.ias.tencent-cloud.net."
                ],
                // 对应协议类型的指标
                "metrics": {
                    // dnd解析时间
                    "dnsTime": 0.02,
                    // 丢包率
                    "packetLostRate": 0,
                    // 建连时间
                    "connectTime": 44,
                    // 重定向时间
                    "redirectTime": 0,
                    // 任务总耗时
                    "totalTime": 395
                },
                // 可用率
                "success": 100,
                // 探测时间
                "monitorTime": "2023-03-06 10:40:55",
                // 任务状态
                // PROBING  - 探测中
                // FINISH   - 已完成
                // FAILED   - 探测失败
                "status": "FINISH"
            }
        ],
        // 任务配置，所有字段与创建任务中的请求相同
        "taskConfig": {
            ...
        }
    },
    "success": true,
    "message": "success"
}

探测详情

请求结构

Method：POST
URL：/csm/api/v1/site/once/groupTask

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	RequestBody参数
siteId	String	任务ID	否	RequestBody参数
siteIds	List<String>	任务id列表，和groupId字段只生效一个，优先groupId	否	RequestBody参数
groupId	String	组id，同源任务为一个组	否	RequestBody参数
pageNo	int	分页数	是	RequestBody参数
pageSize	int	分页大小	是	RequestBody参数
order	String	asc/desc	否	RequestBody参数
orderBy	String	排序字段，只能传对应协议类型的指标名	否	RequestBody参数
filterArea	String	按省市过滤探测结果，优先级更高，和filterIsp二选一	否	RequestBody参数
filterIsp	String	按运营商过滤探测结果，和area只能传一个	否	RequestBody参数

响应示例

POST /csm/api/v1/site/once/groupTask
{
    // 组id，同源任务为一个组
    "groupId": "groub0716ac8-9bf5-4a65-819c-a708f88cd013pId",
 
    // 用户id
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    // 任务详情展示的id，组结果需要过滤当前任务
    "siteId": "jspjUbhwHVotroGFKeRChlriwxlftkxH",
    // 页
    "pageNo": 1,
    // 页大小
    "pageSize": 10,
    // 排序方式
    "order": "desc",
    // 排序字段
    // 为空时默认会取metrics中的第一个指标名
    "orderBy": "monitorTime"
    // 按运营商过滤探测结果，和area只能传一个
    "filterIsp": "CMNET",
}

// Response
{
    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
    "code": 200,
    "result": {
        // 历史任务数
        "totalNum": 1,
        // 任务总探测点数
        "sumSampleNum":66
        // 页
        "pageNo": 1,
        // 页大小
        "pageSize": 10,
        // 排序方式
        "order": "desc",
        // 排序字段
        "orderBy": "monitorTime",
        // 协议类型
        "protocolType": "HTTP",
        // 探测地址
        "url": "www.baidu.com",
        // 任务类型
        // NET_QUALITY  - 网络质量
        "taskType": "NET_QUALITY",
         // 按省市过滤探测结果，优先级更高
        "filterArea": "beijing",
        // 按运营商过滤探测结果，和area只能传一个
        "filterIsp": "CMNET",
        // 组id
        "groupId": "id",
        // 探测结果省市集合
        "allAreas": [
            "hebei",
            "tianjin",
            "hubei",
            "beijing",
            "fujian"
        ],
        // 指标概览
        "overviewData": {
            // 指标部分只会返回该任务协议类型拥有的
            "metrics": {
                // 建连时间
                "connectTime": 17.2,
                // dns解析事件
                "dnsTime": 0.005
            },
            // 可用率
            "success": 89,
            // 采集点总数
            "sumSampleNum": 7,
            // 成功数
            "rightSampleNum": 7,
            // 失败数
            "errSampleNum": 0
        },
        // 探测详情, 探测点列表
        "detailData": [
            {
                // 探测点数据id
                "id": 123,
                // 地区
                "region":"EAST",
                // 地域
                "agentProv": "shanghai",
                // 运营商
                "agentIsp": "CHINANET",
                // 探测ip
                "clientId": "122.137.20.16.1",
                // 探测目标的ip
                "remoteAddr": "220.181.38.150",
                // 探测ip城市
                "clientCity" : "上海",
                // 解析结果ip所在地
                "remoteCity": "保定",
                // 解析结果ip所在省
                "remoteArea":"河北",
                // 解析结果ip所在县/区
                "remoteCounty":"顺平",
                // 协议类型 ipv4/ipv6
                "ipProtocol": "ipv4",
                // 任务url
                "url": "www.baidu.com",
                // dns解析结果
                "analysisResult": [
                    "112.53.42.114",
                    "112.53.42.52",
                    "2402:4e00:1020:1404:0:9227:71a3:83d2",
                    "2402:4e00:1020:1404:0:9227:71ab:2b74",
                    "ins-r23tsuuf.ias.tencent-cloud.net."
                ],
                // 对应协议类型的指标
                "metrics": {
                    // dnd解析时间
                    "dnsTime": 0.02,
                    // 丢包率
                    "packetLostRate": 0,
                    // 建连时间
                    "connectTime": 44,
                    // 重定向时间
                    "redirectTime": 0,
                    // 任务总耗时
                    "totalTime": 395
                },
                // 可用率
                "success": 100,
                // 探测时间
                "monitorTime": "2023-03-06 10:40:55",
                // 任务状态
                // PROBING  - 探测中
                // FINISH   - 已完成
                // FAILED   - 探测失败
                "status": "FINISH"
            }
        ]
    },
    "success": true,
    "message": "success"
}

重新探测

请求结构

Method：POST
URL：/csm/api/v1/site/once/createFromTask

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	RequestBody参数
siteId	String	任务详情展示的id，组结果需要过滤当前任务	是	RequestBody参数

响应示例

POST /csm/api/v1/site/once/createFromTask
{
    // 要重新探测的任务id
    "siteId": "SVierfbmcidTWxysYCsvsHwANzaFh***",
    // 用户id
    "userId": "a0d04d7c202140cb80155ff7b6752***",
}


// Response
{
    "requestId": "10c6cc006a544477918e3440e4a8b026",
    "message": "",
    "success": true,
    "result": {
      // 新的任务id
        "siteId": "LToOrLqHTPhrhTRppTzHJAtMtPNhrmHL",
         // 组id， 获取探测历史用
        "groupId": "dadb06bb-bffe-449d-99b6-d52af98634d4"
    },
    "code": 200
}

历史探测列表

请求结构

Method：POST
URL：/csm/api/v1/site/once/groupTaskList

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	否	RequestBody参数
siteId	String	任务详情展示的id，组结果需要过滤当前任务	否	RequestBody参数
groupId	String	组id	否	RequestBody参数

响应示例

POST /csm/api/v1/site/once/groupTaskList
{
    // 用户id
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    // 组id
    "groupId": "de3cf1fa-a53c-45b0-a331-6a054218b1e4",
    // 当前探测任务的id，历史列表要过滤该id
    "siteId" : "YjrgZFVzXOidYPSgkOzSJZAKuazZAKGH", 
}

// Response
{
    "requestId": "8075cc28167807369286310353357a",
    "code": 200,
    "result": {
        "taskList": [
            {
                // 任务id
                "siteId": "YjrgZFVzXOidYPSgkOzSJZAKuazZAKGH",
                // 组ID，查询探测历史用
                "groupId":"de3cf1fa-a53c-45b0-a331-6a054218b1e4",
                // 探测地址
                "url": "www.baidu.com",
                // 创建时间
                "createTime": "2023-03-06 10:40:14",
            }
        ],
        // 总记录数
        "totalCount": 1
    },
    "success": true,
    "message": "success"
}

探测点接口

获取当前探测点

请求结构

Method：GET
URL：/csm/api/v1/site/once/siteAgent

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	Query参数
ipType	String	ip的类型，ipv6、ipv4两种	否	Query 参数

响应示例

GET /csm/api/v1/site/once/siteAgent?userId=453bf9588c9e488f9ba2c984129090dc 

// Response
{
    "requestId": "6d1cfdc92bc14f99862e1b7fa05713a5",
    "success": true,
    "result": {
        {
            "whiteUser": true,
            "siteAgents": [
                {
                    "agentId": "shandong-CMNET",
                    "agentName": "山东移动",
                    // NORTH     -- 华北
                    // EAST      -- 华东
                    // SOUTH     -- 华南
                    // NORTHEAST -- 东北
                    // CENTRAL   -- 华中
                    // NORTHWEST -- 西北
                    // SOUTHWEST -- 西南
                    "region": "EAST"
                    // ipv4有效探测点
                    "status": 10,
                    // ipv6有效探测点
                    "ipv6Status": 1,
                },
                {
                    "agentId": "xizang-CMNET",
                    "agentName": "西藏移动",
                    "region": "NORTHWEST"
                    "status": 10,
                    "ipv6Status": 1,
                }
            ]
        },
        "code": 200
   }

定时探测（原站点监控）

维度值TopN查询接口

云监控 BCM

云监控 BCM

即时拨测

探测任务相关

创建探测任务

请求结构

请求参数

请求示例

探测历史记录

请求结构

请求参数

请求示例

删除探测记录

请求结构

请求参数

请求示例

探测任务结果

请求结构

请求参数

请求示例

探测详情

请求结构

请求参数

响应示例

重新探测

请求结构

请求参数

响应示例

历史探测列表

请求结构

请求参数

响应示例

探测点接口

获取当前探测点

请求结构

请求参数

响应示例