站点监控
更新时间：2025-08-20
站点监控任务配置相关接口
http(s)任务相关接口
http(s)任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/http/create
/csm/api/v1/userId/{userId}/site/https/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| httpTask | HttpTask | http任务信息 | 是 | query参数 |
HttpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| method | String | 请求类型（get/post） | 是 |
| postContent | String | 发送内容 | 否 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| advanceConfig | Boolean | 是否开启高级配置 | 是 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
advanceConfig为true时需要包含以下参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| cookies | String | 请求cookie | 否 |
| host | String | 请求host | 否 |
| userAgent | String | 请求userAgent | 否 |
| responseCode | String | 期待的响应码 | 否 |
| responseCheck | String | 期待的响应体 | 否 |
| userName | String | 用户名 | 否 |
| password | String | 密码 | 否 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/create
2
3request body:
4{
5 "userId": "453bf9588c9e488f9ba2c984129090dc",
6 "taskName": "bb2_fpm",
7 "address": "baidu.com",
8 "method": "get",
9 "postContent": "",
10 "advanceConfig": false,
11 "cycle": 300,
12 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
13 "timeout": 10,
14 "ipType": "ipv4",
15 "agentCount": 2
16} 响应示例
JSON
1{
2 "taskId": "BbjmjhalUMMeFXfZTUccWWEHchuMbewY",
3 "jobId": "229e2dd7-2f24-43d8-84fa-bce997fefb02"
4}
http(s)任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/http/update
/csm/api/v1/userId/{userId}/site/https/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| httpTask | HttpTask | http任务信息 | 是 | query参数 |
HttpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一id | 是 |
| address | String | 监控地址 | 是 |
| method | String | 请求类型（get/post） | 是 |
| postContent | String | 发送内容 | 否 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| advanceConfig | Boolean | 是否高级 | 是 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
advanceConfig为true时需要包含以下参数
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| cookies | String | 请求cookie | 否 |
| host | String | 请求host | 否 |
| userAgent | String | 请求userAgent | 否 |
| responseCode | String | 期待的响应码 | 否 |
| responseCheck | String | 期待的响应体 | 否 |
| userName | String | 用户名 | 否 |
| password | String | 密码 | 否 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/update
2
3request body:
4{
5 "taskId": "evsjafcgXzRfBpfJAlkKlgSXCkRbYVfx",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb_fpm",
8 "address": "baidu.com",
9 "method": "get",
10 "postContent": "",
11 "advanceConfig": false,
12 "cycle": 600,
13 "idc": "heilongjiang-CMNET,liaoning-CMNET,henan-CMNET",
14 "timeout": 50,
15 "ipType": "ipv4",
16 "agentCount": 2
17}响应示例
JSON
1{
2 "taskId": "evsjafcgXzRfBpfJAlkKlgSXCkRbYVfx",
3 "jobId": "fafe236d-d94a-4425-911e-253cce2a19e8"
4}
http(s)任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/http/detail
/csm/api/v1/userId/{userId}/site/https/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/detail?
2taskId=BbjmjhalUMMeFXfZTUccWWEHchuMbewY响应示例
JSON
1{
2 "scope": "BCM_SITE",
3 "taskName": "bb2_fpm",
4 "address": "http://baidu.com",
5 "type": "http",
6 "cycle": 300,
7 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
8 "idcObjs": [
9 {
10 "id": "shaanxi-CMNET",
11 "name": "陕西移动"
12 },
13 {
14 "id": "heilongjiang-CMNET",
15 "name": "黑龙江移动"
16 },
17 {
18 "id": "liaoning-CMNET",
19 "name": "辽宁移动"
20 },
21 {
22 "id": "jilin-CMNET",
23 "name": "吉林移动"
24 },
25 {
26 "id": "henan-CMNET",
27 "name": "河南移动"
28 }
29 ],
30 "timeout": 10,
31 "advanceConfig": false,
32 "method": "get",
33 "postContent": "",
34 "responseCode": "200",
35 "responseCheck": "",
36 "userName": "",
37 "password": "",
38 "ipType": "ipv4",
39 "agentCount": 2,
40 "agentTotalCount": 10
41}
ping任务相关接口
ping任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/ping/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| pingTask | PingTask | ping任务配置 | 是 | query参数 |
PingTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| packetCount | int | 发包数 | 否 |
| packetLossRate | int | 丢包率 | 否 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/create
2
3request body:
4{
5 "userId": "453bf9588c9e488f9ba2c984129090dc",
6 "taskName": "bb2_ping",
7 "address": "www.baidu.com",
8 "packetCount": 1,
9 "packetLossRate": 5,
10 "cycle": 300,
11 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
12 "timeout": 300,
13 "ipType": "ipv4",
14 "agentCount": 2
15}响应示例
JSON
1{
2 "taskId": "YARlqqyiivVTUbHXTLQcIpFaLyGSXkKU",
3 "jobId": "179a7408-297b-4a1e-9a51-c733267edc29"
4}
ping任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/ping/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| pingTask | PingTask | ping任务配置 | 是 | query参数 |
PingTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一标示 | 是 |
| address | String | 监控地址 | 是 |
| packetCount | int | 发包数 | 否 |
| packetLossRate | int | 丢包率 | 否 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/update
2
3requestbody:
4{
5 "taskId": "OHroEJHEfVuniTNrIUifzAPGYOuawAdW",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb_ping",
8 "address": "www.baidu.com",
9 "packetCount": 1,
10 "packetLossRate": 6,
11 "cycle": 300,
12 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,jilin-UNICOM",
13 "timeout": 10,
14 "ipType": "ipv4",
15 "agentCount": 2
16}响应示例
JSON
1{
2 "taskId": "OHroEJHEfVuniTNrIUifzAPGYOuawAdW",
3 "jobId": "539eb344-d4c1-4d60-a8ba-69980dee2d0e"
4}
ping任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/ping/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/detail?
2taskId=OHroEJHEfVuniTNrIUifzAPGYOuawAdW响应示例
JSON
1{
2 "scope": "BCM_SITE",
3 "taskName": "bb_ping",
4 "address": "www.baidu.com",
5 "type": "ping",
6 "cycle": 300,
7 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,jilin-UNICOM",
8 "idcObjs": [
9 {
10 "id": "shaanxi-CMNET",
11 "name": "陕西移动"
12 },
13 {
14 "id": "heilongjiang-CMNET",
15 "name": "黑龙江移动"
16 },
17 {
18 "id": "liaoning-CMNET",
19 "name": "辽宁移动"
20 },
21 {
22 "id": "liaoning-UNICOM",
23 "name": "辽宁联通"
24 },
25 {
26 "id": "jilin-UNICOM",
27 "name": "吉林联通"
28 }
29 ],
30 "timeout": 10,
31 "packetCount": 1,
32 "packetLossRate": 6,
33 "ipType": "ipv4",
34 "agentCount": 2,
35 "agentTotalCount": 10
36}
TCP任务相关接口
tcp任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/tcp/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| tcpTask | TcpTask | tcp任务配置 | 是 | query参数 |
TcpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒（tcp支持超时范围[1，10]） | 是 |
| advanceConfig | Boolean | 是否高级 | 是 |
| port | int | 端口号 | 是 |
| inputType | int | 输入类型（1：文本 2：十六进制格式 0:无） | 是 |
| outputType | int | 输出类型（1：文本 2：十六进制格式 0:无） | 是 |
| input | String | 请求内容 | 否 |
| expectedOutput | String | 期望输出 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/create
2
3{
4 "userId": "453bf9588c9e488f9ba2c984129090dc",
5 "taskName": "bb2_tcp",
6 "address": "www.taobao.com",
7 "port": 80,
8 "advanceConfig": false,
9 "inputType": 0,
10 "input": "",
11 "outputType": 0,
12 "expectedOutput": "",
13 "cycle": 300,
14 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
15 "timeout": 5,
16 "ipType": "ipv4",
17 "agentCount": 2
18}响应示例
JSON
1{
2 "taskId": "qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU",
3 "jobId": "771291b7-2d83-42c7-966a-d3a7250fa93f"
4}
tcp任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/tcp/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| tcpTask | TcpTask | tcp任务配置 | 是 | query参数 |
TcpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一id | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒（tcp支持超时范围[1,10]） | 是 |
| advanceConfig | Boolean | 是否高级 | 是 |
| port | int | 端口号 | 是 |
| inputType | int | 输入类型（1：文本 2：十六进制格式 0:无） | 是 |
| outputType | int | 输出类型（1：文本 2：十六进制格式 0:无） | 是 |
| input | String | 请求内容 | 否 |
| expectedOutput | String | 期望输出 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/update
2
3requestbody：
4{
5 "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb_tcp",
8 "address": "www.taobao.com",
9 "port": 80,
10 "advanceConfig": false,
11 "inputType": 0,
12 "input": "",
13 "outputType": 0,
14 "expectedOutput": "",
15 "cycle": 600,
16 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
17 "timeout": 5,
18 "ipType": "ipv4",
19 "agentCount": 2
20}响应示例
JSON
1{
2 "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
3 "jobId": "7dfc6342-fb4d-4644-98b2-7401b79983e6"
4}
tcp任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/tcp/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/detail?
2taskId=zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK响应示例
JSON
1{
2 "scope": "BCM_SITE",
3 "taskName": "bb_tcp",
4 "address": "www.taobao.com",
5 "type": "tcp",
6 "cycle": 600,
7 "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
8 "idcObjs": [
9 {
10 "id": "shaanxi-CMNET",
11 "name": "陕西移动"
12 },
13 {
14 "id": "heilongjiang-CMNET",
15 "name": "黑龙江移动"
16 },
17 {
18 "id": "liaoning-CMNET",
19 "name": "辽宁移动"
20 },
21 {
22 "id": "liaoning-UNICOM",
23 "name": "辽宁联通"
24 },
25 {
26 "id": "shanghai-UNICOM",
27 "name": "上海联通"
28 }
29 ],
30 "timeout": 5,
31 "advanceConfig": false,
32 "port": 80,
33 "inputType": 0,
34 "outputType": 0,
35 "input": "",
36 "expectedOutput": "",
37 "ipType": "ipv4",
38 "agentCount": 2,
39 "agentTotalCount": 10
40}
UDP任务相关接口
udp任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/udp/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| udpTask | UdpTask | udp任务配置 | 是 | query参数 |
UdpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| advanceConfig | Boolean | 是否高级 | 是 |
| port | int | 端口号 | 是 |
| inputType | int | 输入类型（1：文本 2：十六进制格式 0:无） | 是 |
| outputType | int | 输出类型（1：文本 2：十六进制格式 0:无） | 是 |
| input | String | 请求内容 | 否 |
| expectedOutput | String | 期望输出 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/create
2
3requestbody:{
4 "userId": "453bf9588c9e488f9ba2c984129090dc",
5 "taskName": "bb2_udp",
6 "address": "www.taobao.com",
7 "port": 80,
8 "inputType": 0,
9 "input": "",
10 "outputType": 0,
11 "expectedOutput": "",
12 "cycle": 300,
13 "idc": "shanghai-CHINANET,shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM",
14 "timeout": 200,
15 "ipType": "ipv4",
16 "agentCount": 2
17}响应示例
JSON
1{
2 "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
3 "jobId": "e0718dda-dfe5-4392-97d2-58580dbf13e0"
4}
udp任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}}/site/udp/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| udpTask | UdpTask | udp任务配置 | 是 | query参数 |
UdpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一id | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| advanceConfig | Boolean | 是否高级 | 是 |
| port | int | 端口号 | 是 |
| inputType | int | 输入类型（1：文本 2：十六进制格式 0:无） | 是 |
| outputType | int | 输出类型（1：文本 2：十六进制格式 0:无） | 是 |
| input | String | 请求内容 | 否 |
| expectedOutput | String | 期望输出 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/update
2
3requestbody：
4{
5 "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb2_udp",
8 "address": "www.taobao.com",
9 "port": 8081,
10 "inputType": 0,
11 "input": "",
12 "outputType": 0,
13 "expectedOutput": "",
14 "cycle": 600,
15 "idc": "shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM,ningxia-CMNET",
16 "timeout": 150,
17 "ipType": "ipv4",
18 "agentCount": 2
19}响应示例
JSON
1{
2 "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
3 "jobId": "86acd46f-4a04-4b56-bacf-1f943366b6ea"
4}
udp任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}}/site/udp/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/detail?
2taskId=aMpuQakYljfaFgwXTABOPTcZdycGCeVk响应示例
JSON
1{
2 "scope": "BCM_SITE",
3 "taskName": "bb2_udp",
4 "address": "www.taobao.com",
5 "type": "udp",
6 "cycle": 600,
7 "idc": "shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM,ningxia-CMNET",
8 "idcObjs": [
9 {
10 "id": "shanghai-UNICOM",
11 "name": "上海联通"
12 },
13 {
14 "id": "jiangsu-UNICOM",
15 "name": "江苏联通"
16 },
17 {
18 "id": "chongqing-UNICOM",
19 "name": "重庆联通"
20 },
21 {
22 "id": "beijing-UNICOM",
23 "name": "北京联通"
24 },
25 {
26 "id": "ningxia-CMNET",
27 "name": "宁夏移动"
28 }
29 ],
30 "timeout": 150,
31 "port": 8081,
32 "inputType": 0,
33 "outputType": 0,
34 "input": "",
35 "expectedOutput": "",
36 "ipType": "ipv4",
37 "agentCount": 2,
38 "agentTotalCount": 10
39}
ftp任务相关接口
ftp任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/ftp/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| ftpTask | FtpTask | ftp任务配置 | 是 | query参数 |
FtpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| port | int | 端口 | 是 |
| anonymousLogin | Boolean | 是否匿名登录 | 是 |
| userName | String | 用户名 | 否 |
| password | String | 密码 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/create
2
3requestbody:
4{
5 "userId": "453bf9588c9e488f9ba2c984129090dc",
6 "taskName": "bb2_ftp",
7 "address": "www.baidu.com",
8 "port": 80,
9 "anonymousLogin": true,
10 "userName": "",
11 "password": "",
12 "cycle": 300,
13 "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
14 "timeout": 100,
15 "ipType": "ipv4",
16 "agentCount": 2
17}响应示例
JSON
1{
2 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
3 "jobId": "65367017-4fe1-451f-a566-4df7583e762c"
4}
ftp任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/ftp/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| ftpTask | FtpTask | ftp任务配置 | 是 | query参数 |
FtpTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一id | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| port | int | 端口 | 是 |
| anonymousLogin | Boolean | 是否匿名登录 | 是 |
| userName | String | 用户名 | 否 |
| password | String | 密码 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/update
2
3requestbody:
4{
5 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb2_ftp",
8 "address": "www.taobao.com",
9 "port": 80,
10 "anonymousLogin": true,
11 "userName": "",
12 "password": null,
13 "cycle": 300,
14 "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
15 "timeout": 200,
16 "ipType": "ipv4",
17 "agentCount": 2
18}返回示例
JSON
1{
2 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
3 "jobId": "849293a0-fa5d-44f4-93eb-2ab3f0679da8"
4}
ftp任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}}/site/ftp/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/detail?taskId=rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH响应示例
JSON
1{
2 "scope": "BCM_SITE",
3 "taskName": "bb2_ftp",
4 "address": "www.taobao.com",
5 "type": "ftp",
6 "cycle": 300,
7 "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
8 "idcObjs": [
9 {
10 "id": "shaanxi-CMNET",
11 "name": "陕西移动"
12 },
13 {
14 "id": "heilongjiang-CMNET",
15 "name": "黑龙江移动"
16 },
17 {
18 "id": "hubei-CMNET",
19 "name": "湖北移动"
20 },
21 {
22 "id": "guizhou-CMNET",
23 "name": "贵州移动"
24 },
25 {
26 "id": "shanxi-CMNET",
27 "name": "山西移动"
28 }
29 ],
30 "timeout": 200,
31 "port": 80,
32 "anonymousLogin": true,
33 "userName": "",
34 "password": null,
35 "ipType": "ipv4",
36 "agentCount": 2,
37 "agentTotalCount": 10
38}
dns任务相关接口
dns任务创建
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/dns/create
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| dnsTask | DnsTask | dns任务配置 | 是 | query参数 |
DnsTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| server | String | DNS服务器（如无需求，不需要设置） | 是 |
| resolveType | String | RECURSION:递归解析;ITERATION:迭代解析 | 是 |
| kidnapWhite | String | 劫持白名单 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/create
2
3requestbody:
4{
5 "scope": "BCM_SITE",
6 "taskName": "pyy_dns_test",
7 "address": "www.baidu.com",
8 "cycle": 60,
9 "idc": "beijing-CMNET,liaoning-CMNET",
10 "timeout": 10,
11 "type": "dns",
12 "server": "8.8.8.8",
13 "resolveType": "RECURSION",
14 "kidnapWhite": "www.baidu.com:196.168.1.*|2400:A480:aa:400:a1:b2:C3:0~FFFF|*"
15 "ipType": "ipv4",
16 "agentCount": 2
17}响应示例
JSON
1{
2 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
3 "jobId": "65367017-4fe1-451f-a566-4df7583e762c"
4}
dns任务更新
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/dns/update
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| dnsTask | FtpTask | dns任务配置 | 是 | query参数 |
DnsTask
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskName | String | 任务名称 | 是 |
| taskId | String | 任务唯一id | 是 |
| address | String | 监控地址 | 是 |
| cycle | Integer | 探测周期 | 是 |
| idc | String | 探测点,使用逗号分隔 | 是 |
| timeout | int | 超时设置，单位秒 | 是 |
| server | String | DNS服务器（如无需求，不需要设置） | 是 |
| resolveType | String | RECURSION:递归解析;ITERATION:迭代解析 | 是 |
| kidnapWhite | String | 劫持白名单 | 否 |
| ipType | String | 协议类型(ipv4/ipv6) | 是 |
| agentCount | int | 统一设置每个省份运营商探测点数量(1-5) | 是 |
请求示例
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/update
2
3requestbody:
4{
5 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
6 "userId": "453bf9588c9e488f9ba2c984129090dc",
7 "taskName": "bb2_ftp",
8 "address": "www.taobao.com",
9 "port": 80,
10 "anonymousLogin": true,
11 "userName": "",
12 "password": null,
13 "cycle": 300,
14 "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
15 "timeout": 200,
16 "ipType": "ipv4",
17 "agentCount": 2
18}返回示例
JSON
1{
2 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
3 "jobId": "849293a0-fa5d-44f4-93eb-2ab3f0679da8"
4}
dns任务详情
- method：GET
- URL：/csm/api/v1/userId/{userId}}/site/dns/detail
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/detail?taskId=rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH响应示例
JSON
1{
2 "taskName": "pyy_dns_test",
3 "address": "www.baidu.com",
4 "cycle": 60,
5 "idc": "beijing-CMNET",
6 "idcObjs": [
7 {
8 "id": "beijing-CMNET",
9 "name": "北京移动"
10 }
11 ],
12 "timeout": 10,
13 "ipType": "ipv4",
14 "server": "8.8.8.8",
15 "resolveType": "RECURSION",
16 "kidnapWhite": "www.baidu.com:196.168.1.*|2400:A480:aa:400:a1:b2:C3:0~FFFF|*",
17 "ipType": "ipv4",
18 "agentCount": 2,
19 "agentTotalCount": 10
20}
站点监控任务列表接口
- method：GET
- URL：/csm/api/v1/userId/{userId}}/site/list
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| query | String | 查询参数，没有搜索条件时，需传 NAME: | 否 | request参数 |
| type | String | 任务类型，http，tcp等 | 否 | request 参数 |
| pageNo | int | 页面数 | 是 | request参数 |
| pageSize | int | 页面大小 | 是 | request参数 |
query
| 类型 | 需要传值 | 举例 |
|---|---|---|
| 根据名称查询 | NAME：值 | NAME：test |
| 根据监控地址 | TARGET：值 | TARGET：www.baidu.com |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/list?
2pageNo=1&
3pageSize=10&
4query=NAME:响应示例
JSON
1{
2 "content": [
3 {
4 "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
5 "taskName": "bb2_ftp",
6 "cycle": 300,
7 "type": "FTP",
8 "address": "www.taobao.com",
9 "status": null
10 },
11 {
12 "taskId": "qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU",
13 "taskName": "bb2_tcp",
14 "cycle": 300,
15 "type": "TCP",
16 "address": "www.taobao.com",
17 "status": null
18 },
19 {
20 "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
21 "taskName": "bb_tcp",
22 "cycle": 600,
23 "type": "TCP",
24 "address": "www.taobao.com",
25 "status": null
26 }
27 ],
28 "query": null,
29 "fields": [],
30 "orderBy": [
31 "-id"
32 ],
33 "pageNumber": 1,
34 "pageSize": 10,
35 "pageElements": 10,
36 "last": true,
37 "first": true,
38 "totalPages": 1,
39 "totalElements": 10
40}
站点监控任务删除接口
- method：DELETE
- URL：/csm/api/v1/userId/{userId}}/site/delete
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/delete?
2taskId=qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU响应示例
JSON
1{
2 "requestId": null,
3 "code": "OK",
4 "message": null
5}站点监控任务查询接口
- method：GET
- URL：/csm/api/v1/userId/{userId}}/site/{siteId}
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| siteId | String | 站点任务id | 是 | path参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH响应示例
JSON
1{
2 "name": "bb2_ftp",
3 "address": "www.taobao.com",
4 "method": "ftp",
5 "siteId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH"
6}
站点报警配置相关接口
创建站点监控报警策略
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/create
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| alarmConfig | SiteAlarmConfig | 站点报警配置 | 是 | query参数 |
SiteAlarmConfig
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskId | String | 任务唯一标示 | 是 |
| comment | String | 注释 | 否 |
| aliasName | String | 报警策略名 | 是 |
| namespace | String | BCM_SITE | 是 |
| level | AlarmLevel | 报警等级: NOTICE, WARNING, CRITICAL, MAJOR, CUSTOM | 是 |
| actionEnabled | Boolean | 通知状态 | 是 |
| resumeActions | Set<String> | 恢复动作 | 是 |
| insufficientActions | Set<String> | 无数据动作 | 是 |
| insufficientCycle | int | 无数据报警判断周期 | 否 |
| rules | List<SiteAlarmRule> | 报警规则 | 是 |
| region | String | 地区 | 否 |
| callbackUrl | String | 报警回调地址 | 否 |
| callbackToken | String | 报警回调token | 否 |
| method | String | 任务类型 | 否 |
| siteMonitor | String | 监控对象：任务类型+任务名称+探测地址 | 否 |
| tag | String | 标识新旧策略，bmc2.0时表示旧策略 | 否 |
| incidentAction | Set<String> | 报警动作 | 是 |
SiteAlarmRule
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| metric | String | 指标项名 | 是 |
| metricAlias | String | 指标项别名 | 是 |
| statistics | String | average:平均值 max:最大值 min:最小值 sum:和值 | 是 |
| thresholed | String | 阈值 | 是 |
| comparisonOperator | String | 比较方式 | 是 |
| cycle | int | 探测周期 | 是 |
| count | int | 次数 | 是 |
| function | String | THRESHOLD：普通报警 CHAIN：环比报警 | 是 |
| actOnIdcs | List<String> | 作用的探测点 | 是 |
| actOnIsps | List<String> | 作用的运营商 | 否 |
| versionSite | String | 任务版本 | 新增不需要，更新需要 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/create
2
3request body :
4{
5 "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
6 "alarmName": "bb_test",
7 "userId": "453bf9588c9e488f9ba2c984129090dc",
8 "namespace": "BCM_SITE",
9 "level": "MAJOR",
10 "actionEnabled": true,
11 "rules": [ {
12 "metric": "connectTime",
13 "metricAlias": "建连时间",
14 "cycle": 300,
15 "statistics": "average",
16 "threshold": "100",
17 "comparisonOperator": ">",
18 "count": 1,
19 "function": "THRESHOLD",
20 "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
21 "actOnIsps": []
22 },
23 {
24 "metric": "dnsTime",
25 "metricAlias": "DNS解析时间",
26 "cycle": 300,
27 "statistics": "average",
28 "threshold": "100",
29 "comparisonOperator": ">",
30 "count": 1,
31 "function": "THRESHOLD",
32 "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
33 "actOnIsps": []
34 } ],
35 "region": "bj",
36 "incidentActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
37 "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
38 "insufficientCycle": 0,
39 "callbackUrl": "",
40 "callbackToken": ""
41}
删除站点监控报警策略
- method：DELETE
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/delete
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| alarmName | SiteAlarmNamesRequest | 要删除的报警策略名 | 是 | query参数 |
SiteAlarmNamesRequest
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| alarmNames | List<String> | 要删除的报警策略名列表 | 是 |
请求示例：
JSON
1DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/delete
2
3request body：
4{
5 "alarmNames":["b87ffe8c1c584b09b2baf15e6244d55d"]
6}
更新站点监控报警策略
- method：PUT
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/update
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| alarmConfig | SiteAlarmConfig | 站点报警配置 | 是 | query参数 |
SiteAlarmConfig
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| taskId | String | 策略名称 | 是 |
| comment | String | 注释 | 否 |
| userId | String | 用户id | 是 |
| alarmName | String | 报警策略名 | 是 |
| namespace | String | BCM_SITE | 是 |
| level | AlarmLevel | 报警等级: NOTICE, WARNING, CRITICAL, MAJOR, CUSTOM | 是 |
| actionEnabled | Boolean | 通知状态 | 是 |
| resumeActions | Set<String> | 恢复动作 | 是 |
| insufficientActions | Set<String> | 无数据动作 | 是 |
| insufficientCycle | int | 无数据报警判断周期 | 否 |
| rules | List<SiteAlarmRule> | 报警规则 | 是 |
| region | String | 地区 | 否 |
| callbackUrl | String | 报警回调地址 | 否 |
| callbackToken | String | 报警回调token | 否 |
| method | String | 任务类型 | 否 |
| siteMonitor | String | 监控对象：任务类型+任务名称+探测地址 | 否 |
| tag | String | 标识新旧策略，bmc2.0时表示旧策略 | 否 |
| incidentAction | Set<String> | 报警动作 | 是 |
SiteAlarmRule
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| metric | String | 指标项名 | 是 |
| metricAlias | String | 指标项别名 | 是 |
| statistics | String | average:平均值 max:最大值 min:最小值 sum:和值 | 是 |
| thresholed | String | 阈值 | 是 |
| comparisonOperator | String | 比较方式 | 是 |
| cycle | int | 探测周期 | 是 |
| count | int | 次数 | 是 |
| function | String | THRESHOLD：普通报警 CHAIN：环比报警 | 是 |
| actOnIdcs | List<String> | 作用的探测点 | 是 |
| actOnIsps | List<String> | 作用的运营商 | 否 |
| versionSite | String | 任务版本 | 新增不需要，更新需要 |
请求示例：
JSON
1PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/update
2
3request body:
4{
5 "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
6 "alarmName": "b87ffe8c1c584b09b2baf15e6244d55d",
7 "userId": "453bf9588c9e488f9ba2c984129090dc",
8 "namespace": "BCM_SITE",
9 "level": "MAJOR",
10 "actionEnabled": true,
11 "rules": [{
12 "metric": "redirectTime",
13 "metricAlias": "重定向时间",
14 "cycle": 300,
15 "statistics": "average",
16 "threshold": "100",
17 "comparisonOperator": ">",
18 "count": 2,
19 "function": "THRESHOLD",
20 "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
21 "actOnIsps": [],
22 "versionSite": "PvwWOucRnClSYewY"
23 }],
24 "region": "bj",
25 "incidentActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
26 "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
27 "insufficientCycle": 0,
28 "callbackUrl": "",
29 "callbackToken": ""
30}
站点监控报警策略详情
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/detail
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| alarmName | String | 要查看的报警策略名 | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/detail?
2alarmName=b87ffe8c1c584b09b2baf15e6244d55d响应示例
JSON
1{
2 "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
3 "comment": "",
4 "userId": "453bf9588c9e488f9ba2c984129090dc",
5 "alarmName": "b87ffe8c1c584b09b2baf15e6244d55d",
6 "namespace": "BCM_SITE",
7 "level": "MAJOR",
8 "actionEnabled": true,
9 "incidentActions": [
10 "cb15e004-c9c5-4498-8ba0-20319161a1c6"
11 ],
12 "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
13 "insufficientActions": [],
14 "insufficientCycle": 0,
15 "rules": [
16 {
17 "id": null,
18 "index": 0,
19 "metric": "redirectTime",
20 "metricAlias": "重定向时间",
21 "statistics": "average",
22 "threshold": "100",
23 "comparisonOperator": ">",
24 "cycle": 300,
25 "count": 2,
26 "function": "THRESHOLD",
27 "sequence": 0,
28 "actOnIdcs": [
29 "average",
30 "shaanxi-CHINANET",
31 "shaanxi-UNICOM",
32 "shaanxi-CMNET",
33 "jiangsu-CMNET"
34 ],
35 "actOnIsps": [],
36 "versionSite": "PvwWOucRnClSYewY"
37 }
38 ],
39 "region": "bj",
40 "callbackUrl": "",
41 "callbackToken": "",
42 "method": "HTTP",
43 "siteMonitor": "HTTP,lh_t_v1,http://baidu.com",
44 "tag": ""
45}
站点监控报警策略列表
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/list
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 站点监控任务id | 否 | request参数 |
| aliasName | String | 报警策略名 | 否 | request参数 |
| actionEnabled | Boolean | 通知状态 | 否 | request参数 |
| pageNo | int | 页数 | 是 | request参数 |
| pageSize | int | 页大小 | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/list?
2taskId=UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA&
3pageNo=1&
4pageSize=10响应示例
JSON
1{
2 "orderBy": "",
3 "order": "",
4 "pageNo": 1,
5 "pageSize": 10,
6 "totalCount": 1,
7 "result": [
8 {
9 "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
10 "comment": "",
11 "userId": "453bf9588c9e488f9ba2c984129090dc",
12 "alarmName": "bb_test",
13 "namespace": "BCM_SITE",
14 "level": "MAJOR",
15 "actionEnabled": true,
16 "incidentActions": [
17 "lh_v1"
18 ],
19 "resumeActions": [],
20 "insufficientActions": [],
21 "insufficientCycle": 0,
22 "rules": [
23 {
24 "id": null,
25 "index": 0,
26 "metric": "redirectTime",
27 "metricAlias": "重定向时间",
28 "statistics": "average",
29 "threshold": "100",
30 "comparisonOperator": ">",
31 "cycle": 300,
32 "count": 2,
33 "function": "THRESHOLD",
34 "sequence": 0,
35 "actOnIdcs": [
36 "average",
37 "shaanxi-CHINANET",
38 "shaanxi-UNICOM",
39 "shaanxi-CMNET",
40 "jiangsu-CMNET"
41 ],
42 "actOnIsps": [],
43 "versionSite": "PvwWOucRnClSYewY"
44 }
45 ],
46 "region": "bj",
47 "callbackUrl": "",
48 "callbackToken": "",
49 "method": "HTTP",
50 "siteMonitor": "HTTP,lh_t_v1,http://baidu.com",
51 "tag": ""
52 }
53 ]
54}
屏蔽站点报警策略
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/block
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| namespace | String | BCM_SITE | 是 | request参数 |
| alarmName | String | 报警策略名 | 是 | request参数 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/block?
2namespace=BCM_SITE&
3alarmName=bb_test2响应示例
JSON
1{"result":{},"success":true}
开启站点报警策略
- method：POST
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/unblock
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| namespace | String | BCM_SITE | 是 | request参数 |
| alarmName | String | 报警策略名 | 是 | request参数 |
请求示例
JSON
1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/unblock?
2namespace=BCM_SITE&
3alarmName=bb_test2响应示例
JSON
1{"result":{},"success":true}
通过报警策略名获得站点任务信息接口
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/alarm/config/{alarmName}
请求参数：
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| alarmName | String | 报警策略名 | 是 | path参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/bb_test响应示例
JSON
1{
2 "name": "lh_t_v1",
3 "address": "http://baidu.com",
4 "method": "http",
5 "siteId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA"
6}
整体概览相关接口
整体趋势图/探测点趋势图/运营商趋势图
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/metricSiteData
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| metricName | String | 指标名 | 是 | request参数 |
| statistics | String[] | 统计方式 | 是 | request参数 |
| startTime | String | utc时间，起始时间 | 是 | request参数 |
| endTime | String | utc时间，结束时间 | 是 | request参数 |
| cycle | int | 周期，默认60s | 是 | request参数 |
| taskId | String | 任务id | 是 | request参数 |
| dimensions | String | 维度 | 否 | request参数 |
dimensions说明
| 接口 | dimensions |
|---|---|
| 整体趋势图 | 空 |
| 探测点趋势图 | beijing-UNICOM |
| 运营商趋势图 | UNICOM |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/metricSiteData?metricName=totalTime&
2statistics=average&
3startTime=2021-04-16T07:05:00Z&
4endTime=2021-04-16T07:10:00Z&
5taskId=NsErRtUYHVtDRZYNfESnBfZLHjnflXsF&
6cycle=60&
7dimensions=beijing-UNICOM返回示例
JSON
1[
2 {
3 "namespace": "NsErRtUYHVtDRZYNfESnBfZLHjnflXsF___bj.BCM_SITE.453bf9588c9e488f9ba2c984129090dc",
4 "dimensions": [
5 {
6 "name": "prov",
7 "value": "beijing"
8 },
9 {
10 "name": "isp",
11 "value": "UNICOM"
12 }
13 ],
14 "dataPoints": [
15 {
16 "timestamp": "2021-04-16T07:05:00Z"
17 },
18 {
19 "timestamp": "2021-04-16T07:06:00Z"
20 },
21 {
22 "timestamp": "2021-04-16T07:07:00Z"
23 },
24 {
25 "timestamp": "2021-04-16T07:08:00Z"
26 },
27 {
28 "timestamp": "2021-04-16T07:09:00Z"
29 }
30 ]
31 }
32]
整体视图接口
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/idc/overallView
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JavaScript
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/idc/overallView?
2taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH响应示例
JSON
1[
2 {
3 "id": "CMNET",
4 "name": "移动",
5 "availability": "0.0",
6 "responseTime": 0.0
7 },
8 {
9 "id": "UNICOM",
10 "name": "联通",
11 "availability": "0.0",
12 "responseTime": 0.0
13 },
14 {
15 "id": "CHINANET",
16 "name": "电信",
17 "availability": "0.0",
18 "responseTime": 0.0
19 }
20]
分省视图接口
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/idc/provincialView
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 参数位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
| isp | String | 运营商 | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/idc/provincialView?
2taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH&
3isp=beijing响应示例
JSON
1[
2 {
3 "id": "beijing-UNICOM",
4 "name": "北京联通",
5 "availability": "98.33",
6 "responseTime": 158.05084745762713
7 }
8]
探测点相关接口
探测点整理
| 省份 | 探测点名称 |
|---|---|
| 安徽 | anhui |
| 北京 | beijing |
| 福建 | fujian |
| 甘肃 | gansu |
| 广东 | guangdong |
| 广西 | guangxi |
| 贵州 | guizhou |
| 海南 | hainan |
| 河北 | hebei |
| 河南 | henan |
| 黑龙江 | heilongjiang |
| 湖北 | hubei |
| 湖南 | hunan |
| 吉林 | jilin |
| 江苏 | jiangsu |
| 江西 | jiangxi |
| 辽宁 | liaoning |
| 内蒙古 | neimenggu |
| 宁夏 | ningxia |
| 青海 | qinghai |
| 山东 | shandong |
| 山西 | shanxi |
| 陕西 | shanxi |
| 上海 | shanghai |
| 四川 | sichuan |
| 天津 | tianjin |
| 西藏 | xizang |
| 新疆 | xinjiang |
| 云南 | yunnan |
| 浙江 | zhejiang |
| 重庆 | chongqing |
| 运营商 | 名称 |
|---|---|
| 电信 | CHINANET |
| 移动 | CMNET |
| 联通 | UNICOM |
注:除了吉林移动、西藏联通、西藏移动外都有探测点
获取所有探测点接口
- method：GET
- URL：/csm/api/v1/userId/{userId}/site/agent/list
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
请求示例：
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/agent/list响应示例
JSON
1[
2 {
3 "agentId": "shaanxi-CMNET",
4 "agentName": "陕西移动"
5 },
6 {
7 "agentId": "heilongjiang-CMNET",
8 "agentName": "黑龙江移动"
9 },
10 {
11 "agentId": "jilin-CHINANET",
12 "agentName": "吉林电信"
13 },
14 {
15 "agentId": "henan-CMNET",
16 "agentName": "河南移动"
17 },
18 {
19 "agentId": "liaoning-CHINANET",
20 "agentName": "辽宁电信"
21 },
22 {
23 "agentId": "henan-UNICOM",
24 "agentName": "河南联通"
25 }
26]
获取某个任务的探测点和运营商接口
method：GET
URL：/csm/api/v1/userId/{userId}/site/agent/idcIsp
请求参数
| 名称 | 类型 | 描述 | 是否必须 | 位置 |
|---|---|---|---|---|
| userId | String | 用户id | 是 | path参数 |
| taskId | String | 任务id | 是 | request参数 |
请求示例
JSON
1GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/agent/idcIsp?
2taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH响应示例
JSON
1{
2 "idcs": [
3 {
4 "id": "average",
5 "name": "全网均值"
6 },
7 {
8 "id": "shanghai-CMNET",
9 "name": "上海移动"
10 },
11 {
12 "id": "beijing-UNICOM",
13 "name": "北京联通"
14 },
15 {
16 "id": "guangdong-CHINANET",
17 "name": "广东电信"
18 }
19 ],
20 "isps": [
21 {
22 "id": "CMNET",
23 "name": "移动"
24 },
25 {
26 "id": "CHINANET",
27 "name": "电信"
28 },
29 {
30 "id": "UNICOM",
31 "name": "联通"
32 }
33 ]
34}