1POST /csm/api/v1/site/once/HTTP/taskCreate
2{
3    "userId": "453bf9588c9e488f9ba2c984129090dc",
4 // Probe address
5    "address": "www.baidu.com",
6 // Whether to enable advanced configuration. HTTP/HTTPS/TCP is applicable
7    "advancedFlag": true,
8 // Probe node type ipv4/ipv6
9    "ipType": "ipv4",
10 // Probe node
11    "idc": "beijing-CMNET,beijing-UNICOM,beijing-CHINANET,guangdong-CMNET,fujian-CMNET,henan-CMNET,hebei-CHINANET",
12 // Timeout duration
13    "timeout": 60,
14 // Protocol type
15 // Protocol types, in uppercase
16    "protocolType": "HTTP",
17 // Task type
18 // NET_QUAILTY  - Network quality
19    "taskType": "NET_QUAILTY",
20    "onceConfig": {
21        // HTTP/HTTPS
22 // Request method
23        "method": "get",
24 // HTTP POST request content
25        "postContent": "",
26        
27        // DNS
28 // DNS allow list
29        "kidnapWhite": "192.168.1.1",
30 // Query method
31        "resolveType": "RECURSION",
32 // DNS server
33        "server": "114.114.114.114",
34        
35        // PING
36 // Ping packet count
37        "packetCount": 4,
38        
39 // TCP/UDP/FTP port number
40        "port": 22,
41        
42        // UDP
43 // UDP request format
44        "inputType": 2,
45 // UDP request content
46        "input": "0x11",
47 // UDP response matching format
48        "outputType": 2,
49 // UDP response content matching
50        "expectedOutput": "0x11",
51        
52        // FTP
53 // FTP login name
54        "username": "",
55 // FTP login password
56        "password": ""
57    },
58    "advancedConfig": {
59        // HTTP/HTTPS
60 // Cookie field in request headers
61        "cookies": "auth=abc",
62 // User-Agent field in request headers
63        "userAgent": "os=macOS",
64 // HOST field in request headers
65        "host": "1.1.1.1",
66        // HTTP Code
67        "responseCode": "200",
68 // Response content matching
69        "responseCheck": "success",
70 // HTTP certification username
71        "username": "admin",
72 // HTTP certification password
73        "password": "",
74        
75        // TCP
76 // TCP request format
77        "inputType": 2,
78 // TCP request content
79        "input": "0x11",
80 // TCP response matching format
81        "outputType": 2,
82 // TCP response content matching
83        "expectedOutput": "0x11"
84    }
85}
86// Response
87{
88    "requestId":"90742375b871445d8907be7748397ef4",
89    "success":true,
90    "result":{
91 // Task ID
92        "siteId":"jspjUbhwHVotroGFKeRChlriwxlftkxH",
93 // Task group ID
94        "groupId":"be388838-9381-423e-b4ac-afac8dfe70e3"
95    },
96    "code":200
97}

1POST /csm/api/v1/site/once/taskList
2{
3 // Request page
4    "pageNo":1,
5 // Request page size
6    "pageSize":10,
7 // User ID
8    "userId": "453bf9588c9e488f9ba2c984129090dc",
9 // Search URL, fuzzy matching supported
10    "url": "baidu"
11}
12// Response
13{
14    "requestId": "8075cc28167807369286310353357a",
15    "code": 200,
16    "result": {
17        "taskList": [
18            {
19 // Task ID
20                "siteId": "PymZbqvHNJfXRcvSEiBOHmcfBWNAjaDB",
21 // Group ID, used for querying historical probe
22                "groupId":"be388838-9381-423e-b4ac-afac8dfe70e3",
23 // User
24                "userId": "a0d04d7c202140cb80155ff7b6752ce4",
25 // Task type, currently only network quality
26 // NET_QUALITY   - Network quality
27                "taskType": "NET_QUALITY",
28 // Protocol type
29                "protocolType": "HTTP",
30 // Probe address
31                "url": "www.baidu.com",
32 // Total probe nodes of task
33                "agentNum": 7,
34 // Total probe nodes in response result
35                "sumSampleNum": 7,
36 // Overall availability rate, calculated from all probe nodes
37                "success": 100,
38 // Probe time, when the probe result is completed
39                "monitorTime": "2023-03-06 10:40:14",
40 // Creation time
41                "createTime": "2023-03-06 10:40:14",
42 // Task status
43 // PROBING - in progress
44 // FINISH   - completed
45 // FAILED   - failed
46                "status": "FINISH"
47            }
48        ],
49 // Current page
50        "pageNo": 1,
51 // Page size
52        "pageSize": 10,
53 // Total records
54        "totalCount": 1
55    },
56    "success": true,
57    "message": "success"
58}

1POST /csm/api/v1/site/once/taskDelete
2{
3 // User ID
4    "userId":"453bf9588c9e488f9ba2c984129090dc",
5 // Probe task ID
6    "siteId":"vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr"
7}
8// Response
9{
10    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
11    "message": "",
12    "success": true,
13    "result": {
14 "siteId": "vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr",  // Deleted task ID
15        "groupId": "d13f2b4a-1892-44cb-a3f4-0c7ede23826d"
16    },
17    "code": 200
18}

1 POST /csm/api/v1/site/once/loadData
2{
3 // Request page
4    "pageNo":1,
5 // Request page size
6    "pageSize":10,
7 // Filter probe results by province/city, higher priority
8    "filterArea": "beijing",
9
10 // User ID
11    "userId":"453bf9588c9e488f9ba2c984129090dc",
12 // Probe task ID
13    "siteId":"vLZFWRbcubOVuPgQVgNdZsBiNRuuHIIr"
14}
15// Response
16{
17    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
18    "code": 200,
19    "result": {
20 // Total probe nodes
21        "totalNum": 1,
22 // Page
23        "pageNo": 1,
24 // Page size
25        "pageSize": 10,
26 // Sorting order
27        "order": "desc",
28 // Sorting field
29        "orderBy": "monitorTime",
30 // Task status
31 // PROBING - in progress
32 // FINISH   - completed
33 // FAILED - Failed
34        "status": "FINISH",
35 // Protocol type
36        "protocolType": "HTTP",
37 // Probe address
38        "url": "www.baidu.com",
39 // Task type
40 // NET_QUALITY   - Network quality
41        "taskType": "NET_QUALITY",
42 // Filter probe results by province/city, higher priority
43        "filterArea": "beijing",
44 // Filter probe results by operator, choose between this or area
45        "filterIsp": "CMNET",
46 // Site task ID
47        "siteId": "id",
48 // NMP-side task ID
49        "jobId": "id",
50 // Task group ID
51        "groupId": "id",
52 // User ID
53        "userId": "id",
54 // Task type metrics names, with fixed order
55        "metricOrder": [
56            "totalTime",
57            "dnsTime",
58            "dnsKidnap"
59        ],
60 // Province/city collection
61        "allAreas": [
62            "hebei",
63            "tianjin",
64            "hubei",
65            "beijing",
66            "fujian"
67        ],
68 // Metric overview
69        "overviewData": {
70 // Those included in the protocol types of the task will only be returned in the metrics section
71            "metrics": {
72 // Connection establishment time
73                "connectTime": 17.2,
74 // DNS resolution event
75                "dnsTime": 0.005
76            },
77 // Availability rate
78            "success": 89,
79 // Total probe nodes
80            "sumSampleNum": 7,
81 // Success count
82            "rightSampleNum": 7,
83 // Failure count
84            "errSampleNum": 0
85        },
86 // Probe details, probe node list
87        "detailData": [
88            {
89 // Probe node data ID
90                "id": 123,
91 // Region
92                "agentProv": "shanghai",
93 // Operator
94                "agentIsp": "CHINANET",
95 // Probe endpoint ID
96                "clientId": "122.137.20.16.1",
97 // Probe endpoint city
98 "clientCity": "Shanghai",
99 // Resolved IP
100                "remoteAddr": "220.181.38.150",
101 // Location of resolved IP
102 "remoteCity": "Baoding",
103 // Province of resolved IP
104 "remoteArea": "Hebei",
105 // County/district of resolved IP
106 "remoteCounty": "Shunping",
107 // Protocol type: ipv4/ipv6
108                "ipProtocol": "ipv4",
109 // Task URL
110                "url": "www.baidu.com",
111 // DNS resolved result
112                "analysisResult": [
113                    "112.53.42.114",
114                    "112.53.42.52",
115                    "2402:4e00:1020:1404:0:9227:71a3:83d2",
116                    "2402:4e00:1020:1404:0:9227:71ab:2b74",
117                    "ins-r23tsuuf.ias.tencent-cloud.net."
118                ],
119 // Metrics corresponding to protocol type
120                "metrics": {
121 // DND resolution time
122                    "dnsTime": 0.02,
123 // Packet loss rate
124                    "packetLostRate": 0,
125 // Connection establishment time
126                    "connectTime": 44,
127 // Redirection time
128                    "redirectTime": 0,
129 // Total task duration
130                    "totalTime": 395
131                },
132 // Availability rate
133                "success": 100,
134 // Probe time
135                "monitorTime": "2023-03-06 10:40:55",
136 // Task status
137 // PROBING - in progress
138 // FINISH   - completed
139 // FAILED   - failed
140                "status": "FINISH"
141            }
142        ],
143 // Task configuration, all fields identical to the Request when creating a task
144        "taskConfig": {
145            ...
146        }
147    },
148    "success": true,
149    "message": "success"
150}

1POST /csm/api/v1/site/once/groupTask
2{
3 // Group ID, tasks from the same source belong to one group
4    "groupId": "groub0716ac8-9bf5-4a65-819c-a708f88cd013pId",
5
6 // User ID
7    "userId": "453bf9588c9e488f9ba2c984129090dc",
8 // ID displayed in Task Details, group results need to filter the current task
9    "siteId": "jspjUbhwHVotroGFKeRChlriwxlftkxH",
10 // Page
11    "pageNo": 1,
12 // Page size
13    "pageSize": 10,
14 // Sorting order
15    "order": "desc",
16 // Sorting field
17 // When null, the first metrics name in metrics will be taken by default
18    "orderBy": "monitorTime"
19 // Filter probe results by operator, choose between this or area
20    "filterIsp": "CMNET",
21}
22// Response
23{
24    "requestId": "aa2431ff8cb74ba2b9a26d788209a77b",
25    "code": 200,
26    "result": {
27 // Historical task count
28        "totalNum": 1,
29 // Total probe nodes for the task
30        "sumSampleNum":66
31 // Page
32        "pageNo": 1,
33 // Page size
34        "pageSize": 10,
35 // Sorting order
36        "order": "desc",
37 // Sorting field
38        "orderBy": "monitorTime",
39 // Protocol type
40        "protocolType": "HTTP",
41 // Probe address
42        "url": "www.baidu.com",
43 // Task type
44 // NET_QUALITY   - Network quality
45        "taskType": "NET_QUALITY",
46 // Filter probe results by province/city, higher priority
47        "filterArea": "beijing",
48 // Filter probe results by operator, choose between this or area
49        "filterIsp": "CMNET",
50 // Group ID
51        "groupId": "id",
52 // Province/city collection of probe results
53        "allAreas": [
54            "hebei",
55            "tianjin",
56            "hubei",
57            "beijing",
58            "fujian"
59        ],
60 // Metric overview
61        "overviewData": {
62 // Those included in the protocol types of the task will only be returned in the metrics section
63            "metrics": {
64 // Connection establishment time
65                "connectTime": 17.2,
66 // DNS resolution event
67                "dnsTime": 0.005
68            },
69 // Availability rate
70            "success": 89,
71 // Total probe nodes
72            "sumSampleNum": 7,
73 // Success count
74            "rightSampleNum": 7,
75 // Failure count
76            "errSampleNum": 0
77        },
78 // Probe details, probe node list
79        "detailData": [
80            {
81 // Probe node data ID
82                "id": 123,
83 // Region
84                "region":"EAST",
85 // Region
86                "agentProv": "shanghai",
87 // Operator
88                "agentIsp": "CHINANET",
89 // Probe IP
90                "clientId": "122.137.20.16.1",
91 // Target IP for probe
92                "remoteAddr": "220.181.38.150",
93 // Probe IP city
94 "clientCity": "Shanghai",
95 // Location of resolved IP
96 "remoteCity": "Baoding",
97 // Province of resolved IP
98 "remoteArea": "Hebei",
99 // County/district of resolved IP
100 "remoteCounty": "Shunping",
101 // Protocol type: ipv4/ipv6
102                "ipProtocol": "ipv4",
103 // Task URL
104                "url": "www.baidu.com",
105 // DNS resolved result
106                "analysisResult": [
107                    "112.53.42.114",
108                    "112.53.42.52",
109                    "2402:4e00:1020:1404:0:9227:71a3:83d2",
110                    "2402:4e00:1020:1404:0:9227:71ab:2b74",
111                    "ins-r23tsuuf.ias.tencent-cloud.net."
112                ],
113 // Metrics corresponding to protocol type
114                "metrics": {
115 // DND resolution time
116                    "dnsTime": 0.02,
117 // Packet loss rate
118                    "packetLostRate": 0,
119 // Connection establishment time
120                    "connectTime": 44,
121 // Redirection time
122                    "redirectTime": 0,
123 // Total task duration
124                    "totalTime": 395
125                },
126 // Availability rate
127                "success": 100,
128 // Probe time
129                "monitorTime": "2023-03-06 10:40:55",
130 // Task status
131 // PROBING - in progress
132 // FINISH   - completed
133 // FAILED   - failed
134                "status": "FINISH"
135            }
136        ]
137    },
138    "success": true,
139    "message": "success"
140}

1POST /csm/api/v1/site/once/createFromTask
2{
3 // Task ID to be reprobed
4    "siteId": "SVierfbmcidTWxysYCsvsHwANzaFh***",
5 // User ID
6    "userId": "a0d04d7c202140cb80155ff7b6752***",
7}
8// Response
9{
10    "requestId": "10c6cc006a544477918e3440e4a8b026",
11    "message": "",
12    "success": true,
13    "result": {
14 // New task ID
15        "siteId": "LToOrLqHTPhrhTRppTzHJAtMtPNhrmHL",
16 // Group ID, used to obtain historical probe
17        "groupId": "dadb06bb-bffe-449d-99b6-d52af98634d4"
18    },
19    "code": 200
20}

1POST /csm/api/v1/site/once/groupTaskList
2{
3 // User ID
4    "userId": "453bf9588c9e488f9ba2c984129090dc",
5 // Group ID
6    "groupId": "de3cf1fa-a53c-45b0-a331-6a054218b1e4",
7 // ID of the current probe task, which should be filtered out in the historical probe list
8    "siteId" : "YjrgZFVzXOidYPSgkOzSJZAKuazZAKGH",
9}
10// Response
11{
12    "requestId": "8075cc28167807369286310353357a",
13    "code": 200,
14    "result": {
15        "taskList": [
16            {
17 // Task ID
18                "siteId": "YjrgZFVzXOidYPSgkOzSJZAKuazZAKGH",
19 // Group ID, used for querying historical probe
20                "groupId":"de3cf1fa-a53c-45b0-a331-6a054218b1e4",
21 // Probe address
22                "url": "www.baidu.com",
23 // Creation time
24                "createTime": "2023-03-06 10:40:14",
25            }
26        ],
27 // Total records
28        "totalCount": 1
29    },
30    "success": true,
31    "message": "success"
32}

1GET /csm/api/v1/site/once/siteAgent?userId=453bf9588c9e488f9ba2c984129090dc
2// Response
3{
4    "requestId": "6d1cfdc92bc14f99862e1b7fa05713a5",
5    "success": true,
6    "result": {
7        {
8            "whiteUser": true,
9            "siteAgents": [
10                {
11                    "agentId": "shandong-CMNET",
12 "agentName": "Shandong Branch of China Mobile",
13 // NORTH -- North China
14 // EAST      -- East China
15 // SOUTH     -- South China
16 // NORTHEAST -- Northeast China
17 // CENTRAL   -- Central China
18 // NORTHWEST -- Northwest China
19 // SOUTHWEST -- Southwest China
20                    "region": "EAST"
21 // Valid ipv4 probe nodes
22                    "status": 10,
23 // Valid ipv6 probe nodes
24                    "ipv6Status": 1,
25                },
26                {
27                    "agentId": "xizang-CMNET",
28 "agentName": "Tibet Branch of China Mobile",
29                    "region": "NORTHWEST"
30                    "status": 10,
31                    "ipv6Status": 1,
32                }
33            ]
34        },
35        "code": 200
36   }