站点监控

更新时间：2024-01-26

站点监控任务配置相关接口

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/create

request body:
{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_fpm",
    "address": "baidu.com",
    "method": "get",
    "postContent": "",
    "advanceConfig": false,
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
    "timeout": 10,
    "ipType": "ipv4",
    "agentCount": 2
}    
            

响应示例

                JSON
                
                {
    "taskId": "BbjmjhalUMMeFXfZTUccWWEHchuMbewY",
    "jobId": "229e2dd7-2f24-43d8-84fa-bce997fefb02"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/update

request body:
{
    "taskId": "evsjafcgXzRfBpfJAlkKlgSXCkRbYVfx",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb_fpm",
    "address": "baidu.com",
    "method": "get",
    "postContent": "",
    "advanceConfig": false,
    "cycle": 600,
    "idc": "heilongjiang-CMNET,liaoning-CMNET,henan-CMNET",
    "timeout": 50,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "evsjafcgXzRfBpfJAlkKlgSXCkRbYVfx",
    "jobId": "fafe236d-d94a-4425-911e-253cce2a19e8"
}

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
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/detail?
taskId=BbjmjhalUMMeFXfZTUccWWEHchuMbewY

响应示例

                JSON
                
            

                {
    "scope": "BCM_SITE",
    "taskName": "bb2_fpm",
    "address": "http://baidu.com",
    "type": "http",
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
    "idcObjs": [
        {
            "id": "shaanxi-CMNET",
            "name": "陕西移动"
        },
        {
            "id": "heilongjiang-CMNET",
            "name": "黑龙江移动"
        },
        {
            "id": "liaoning-CMNET",
            "name": "辽宁移动"
        },
        {
            "id": "jilin-CMNET",
            "name": "吉林移动"
        },
        {
            "id": "henan-CMNET",
            "name": "河南移动"
        }
    ],
    "timeout": 10,
    "advanceConfig": false,
    "method": "get",
    "postContent": "",
    "responseCode": "200",
    "responseCheck": "",
    "userName": "",
    "password": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/create

request body:
{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_ping",
    "address": "www.baidu.com",
    "packetCount": 1,
    "packetLossRate": 5,
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,jilin-CMNET,henan-CMNET",
    "timeout": 300,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "YARlqqyiivVTUbHXTLQcIpFaLyGSXkKU",
    "jobId": "179a7408-297b-4a1e-9a51-c733267edc29"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/update

requestbody:
{
    "taskId": "OHroEJHEfVuniTNrIUifzAPGYOuawAdW",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb_ping",
    "address": "www.baidu.com",
    "packetCount": 1,
    "packetLossRate": 6,
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,jilin-UNICOM",
    "timeout": 10,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "OHroEJHEfVuniTNrIUifzAPGYOuawAdW",
    "jobId": "539eb344-d4c1-4d60-a8ba-69980dee2d0e"
}

ping任务详情

method：GET
URL：/csm/api/v1/userId/{userId}/site/ping/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ping/detail?
taskId=OHroEJHEfVuniTNrIUifzAPGYOuawAdW

响应示例

                JSON
                
            

                {
    "scope": "BCM_SITE",
    "taskName": "bb_ping",
    "address": "www.baidu.com",
    "type": "ping",
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,jilin-UNICOM",
    "idcObjs": [
        {
            "id": "shaanxi-CMNET",
            "name": "陕西移动"
        },
        {
            "id": "heilongjiang-CMNET",
            "name": "黑龙江移动"
        },
        {
            "id": "liaoning-CMNET",
            "name": "辽宁移动"
        },
        {
            "id": "liaoning-UNICOM",
            "name": "辽宁联通"
        },
        {
            "id": "jilin-UNICOM",
            "name": "吉林联通"
        }
    ],
    "timeout": 10,
    "packetCount": 1,
    "packetLossRate": 6,
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/create

{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_tcp",
    "address": "www.taobao.com",
    "port": 80,
    "advanceConfig": false,
    "inputType": 0,
    "input": "",
    "outputType": 0,
    "expectedOutput": "",
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
    "timeout": 5,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU",
    "jobId": "771291b7-2d83-42c7-966a-d3a7250fa93f"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/update

requestbody：
{
    "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb_tcp",
    "address": "www.taobao.com",
    "port": 80,
    "advanceConfig": false,
    "inputType": 0,
    "input": "",
    "outputType": 0,
    "expectedOutput": "",
    "cycle": 600,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
    "timeout": 5,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
    "jobId": "7dfc6342-fb4d-4644-98b2-7401b79983e6"
}

tcp任务详情

method：GET
URL：/csm/api/v1/userId/{userId}/site/tcp/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/tcp/detail?
taskId=zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK

响应示例

                JSON
                
            

                {
    "scope": "BCM_SITE",
    "taskName": "bb_tcp",
    "address": "www.taobao.com",
    "type": "tcp",
    "cycle": 600,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,liaoning-CMNET,liaoning-UNICOM,shanghai-UNICOM",
    "idcObjs": [
        {
            "id": "shaanxi-CMNET",
            "name": "陕西移动"
        },
        {
            "id": "heilongjiang-CMNET",
            "name": "黑龙江移动"
        },
        {
            "id": "liaoning-CMNET",
            "name": "辽宁移动"
        },
        {
            "id": "liaoning-UNICOM",
            "name": "辽宁联通"
        },
        {
            "id": "shanghai-UNICOM",
            "name": "上海联通"
        }
    ],
    "timeout": 5,
    "advanceConfig": false,
    "port": 80,
    "inputType": 0,
    "outputType": 0,
    "input": "",
    "expectedOutput": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/create

requestbody:{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_udp",
    "address": "www.taobao.com",
    "port": 80,
    "inputType": 0,
    "input": "",
    "outputType": 0,
    "expectedOutput": "",
    "cycle": 300,
    "idc": "shanghai-CHINANET,shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM",
    "timeout": 200,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
    "jobId": "e0718dda-dfe5-4392-97d2-58580dbf13e0"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/update

requestbody：
{
    "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_udp",
    "address": "www.taobao.com",
    "port": 8081,
    "inputType": 0,
    "input": "",
    "outputType": 0,
    "expectedOutput": "",
    "cycle": 600,
    "idc": "shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM,ningxia-CMNET",
    "timeout": 150,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "aMpuQakYljfaFgwXTABOPTcZdycGCeVk",
    "jobId": "86acd46f-4a04-4b56-bacf-1f943366b6ea"
}

udp任务详情

method：GET
URL：/csm/api/v1/userId/{userId}}/site/udp/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/udp/detail?
taskId=aMpuQakYljfaFgwXTABOPTcZdycGCeVk

响应示例

                JSON
                
            

                {
    "scope": "BCM_SITE",
    "taskName": "bb2_udp",
    "address": "www.taobao.com",
    "type": "udp",
    "cycle": 600,
    "idc": "shanghai-UNICOM,jiangsu-UNICOM,chongqing-UNICOM,beijing-UNICOM,ningxia-CMNET",
    "idcObjs": [
        {
            "id": "shanghai-UNICOM",
            "name": "上海联通"
        },
        {
            "id": "jiangsu-UNICOM",
            "name": "江苏联通"
        },
        {
            "id": "chongqing-UNICOM",
            "name": "重庆联通"
        },
        {
            "id": "beijing-UNICOM",
            "name": "北京联通"
        },
        {
            "id": "ningxia-CMNET",
            "name": "宁夏移动"
        }
    ],
    "timeout": 150,
    "port": 8081,
    "inputType": 0,
    "outputType": 0,
    "input": "",
    "expectedOutput": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/create

requestbody:
{
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_ftp",
    "address": "www.baidu.com",
    "port": 80,
    "anonymousLogin": true,
    "userName": "",
    "password": "",
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
    "timeout": 100,
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "jobId": "65367017-4fe1-451f-a566-4df7583e762c"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/update

requestbody:
{
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_ftp",
    "address": "www.taobao.com",
    "port": 80,
    "anonymousLogin": true,
    "userName": "",
    "password": null,
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
    "timeout": 200,
    "ipType": "ipv4",
    "agentCount": 2
}
            

返回示例

                JSON
                
                {
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "jobId": "849293a0-fa5d-44f4-93eb-2ab3f0679da8"
}

ftp任务详情

method：GET
URL：/csm/api/v1/userId/{userId}}/site/ftp/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/ftp/detail?taskId=rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH

响应示例

                JSON
                
            

                {
    "scope": "BCM_SITE",
    "taskName": "bb2_ftp",
    "address": "www.taobao.com",
    "type": "ftp",
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
    "idcObjs": [
        {
            "id": "shaanxi-CMNET",
            "name": "陕西移动"
        },
        {
            "id": "heilongjiang-CMNET",
            "name": "黑龙江移动"
        },
        {
            "id": "hubei-CMNET",
            "name": "湖北移动"
        },
        {
            "id": "guizhou-CMNET",
            "name": "贵州移动"
        },
        {
            "id": "shanxi-CMNET",
            "name": "山西移动"
        }
    ],
    "timeout": 200,
    "port": 80,
    "anonymousLogin": true,
    "userName": "",
    "password": null,
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/create

requestbody:
{
    "scope": "BCM_SITE",
    "taskName": "pyy_dns_test",
    "address": "www.baidu.com",
    "cycle": 60,
    "idc": "beijing-CMNET,liaoning-CMNET",
    "timeout": 10,
    "type": "dns",
    "server": "8.8.8.8",
    "resolveType": "RECURSION",
    "kidnapWhite": "www.baidu.com:196.168.1.*|2400:A480:aa:400:a1:b2:C3:0~FFFF|*"
    "ipType": "ipv4",
    "agentCount": 2
}
            

响应示例

                JSON
                
                {
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "jobId": "65367017-4fe1-451f-a566-4df7583e762c"
}

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/update

requestbody:
{
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "taskName": "bb2_ftp",
    "address": "www.taobao.com",
    "port": 80,
    "anonymousLogin": true,
    "userName": "",
    "password": null,
    "cycle": 300,
    "idc": "shaanxi-CMNET,heilongjiang-CMNET,hubei-CMNET,guizhou-CMNET,shanxi-CMNET",
    "timeout": 200,
    "ipType": "ipv4",
    "agentCount": 2
}
            

返回示例

                JSON
                
                {
    "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
    "jobId": "849293a0-fa5d-44f4-93eb-2ab3f0679da8"
}

dns任务详情

method：GET
URL：/csm/api/v1/userId/{userId}}/site/dns/detail

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/dns/detail?taskId=rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH

响应示例

                JSON
                
            

                {
      "taskName": "pyy_dns_test",
      "address": "www.baidu.com",
      "cycle": 60,
      "idc": "beijing-CMNET",
      "idcObjs": [
            {
                  "id": "beijing-CMNET",
                  "name": "北京移动"
            }
      ],
      "timeout": 10,
      "ipType": "ipv4",
      "server": "8.8.8.8",
      "resolveType": "RECURSION",
      "kidnapWhite": "www.baidu.com:196.168.1.*|2400:A480:aa:400:a1:b2:C3:0~FFFF|*",
      "ipType": "ipv4",
      "agentCount": 2,
      "agentTotalCount": 10
}
            

站点监控任务列表接口

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
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/list?
pageNo=1&
pageSize=10&
query=NAME:

响应示例

                JSON
                
            

                {
    "content": [
        {
            "taskId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH",
            "taskName": "bb2_ftp",
            "cycle": 300,
            "type": "FTP",
            "address": "www.taobao.com",
            "status": null
        },
        {
            "taskId": "qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU",
            "taskName": "bb2_tcp",
            "cycle": 300,
            "type": "TCP",
            "address": "www.taobao.com",
            "status": null
        },
        {
            "taskId": "zdBBpHOftpxxdPxwKLZHobmFQyMlHoIK",
            "taskName": "bb_tcp",
            "cycle": 600,
            "type": "TCP",
            "address": "www.taobao.com",
            "status": null
        }
    ],
    "query": null,
    "fields": [],
    "orderBy": [
        "-id"
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "pageElements": 10,
    "last": true,
    "first": true,
    "totalPages": 1,
    "totalElements": 10
}
            

站点监控任务删除接口

method：DELETE
URL：/csm/api/v1/userId/{userId}}/site/delete

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/delete?
taskId=qztvcDiQydeiPmLgFNmpHrpuBNsRSvyU

响应示例

                JSON
                
            

                {
    "requestId": null,
    "code": "OK",
    "message": null
}
            

站点监控任务查询接口

method：GET
URL：/csm/api/v1/userId/{userId}}/site/{siteId}

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
siteId	String	站点任务id	是	path参数

请求示例

                JSON
                
                GET  /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH

响应示例

                JSON
                
            

                {
    "name": "bb2_ftp",
    "address": "www.taobao.com",
    "method": "ftp",
    "siteId": "rYwPZMATMzXbTXYauUXbQGDUyoGQnGWH"
}
            

站点报警配置相关接口

创建站点监控报警策略

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
                
            

                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/create

request body :
{
    "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
    "alarmName": "bb_test",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "namespace": "BCM_SITE",
    "level": "MAJOR",
    "actionEnabled": true,
    "rules": [ {
        "metric": "connectTime",
        "metricAlias": "建连时间",
        "cycle": 300,
        "statistics": "average",
        "threshold": "100",
        "comparisonOperator": ">",
        "count": 1,
        "function": "THRESHOLD",
        "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
        "actOnIsps": []
    }, 
    {
        "metric": "dnsTime",
        "metricAlias": "DNS解析时间",
        "cycle": 300,
        "statistics": "average",
        "threshold": "100",
        "comparisonOperator": ">",
        "count": 1,
        "function": "THRESHOLD",
        "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
        "actOnIsps": []
    } ],
    "region": "bj",
    "incidentActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
    "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
    "insufficientCycle": 0,
    "callbackUrl": "",
    "callbackToken": ""
}
            

删除站点监控报警策略

method：DELETE
URL：/csm/api/v1/userId/{userId}/site/alarm/config/delete

请求参数：

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
alarmName	SiteAlarmNamesRequest	要删除的报警策略名	是	query参数

SiteAlarmNamesRequest

名称	类型	描述	是否必须
alarmNames	List<String>	要删除的报警策略名列表	是

请求示例：

                JSON
                
                DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/delete

request body：
{
  "alarmNames":["b87ffe8c1c584b09b2baf15e6244d55d"]
}

更新站点监控报警策略

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
                
            

                PUT /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/update

request body:
{
    "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
    "alarmName": "b87ffe8c1c584b09b2baf15e6244d55d",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "namespace": "BCM_SITE",
    "level": "MAJOR",
    "actionEnabled": true,
    "rules": [{
        "metric": "redirectTime",
        "metricAlias": "重定向时间",
        "cycle": 300,
        "statistics": "average",
        "threshold": "100",
        "comparisonOperator": ">",
        "count": 2,
        "function": "THRESHOLD",
        "actOnIdcs": ["average", "shaanxi-CHINANET", "shaanxi-UNICOM", "shaanxi-CMNET", "jiangsu-CMNET"],
        "actOnIsps": [],
        "versionSite": "PvwWOucRnClSYewY"
    }],
    "region": "bj",
    "incidentActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
    "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
    "insufficientCycle": 0,
    "callbackUrl": "",
    "callbackToken": ""
}
            

站点监控报警策略详情

method：GET
URL：/csm/api/v1/userId/{userId}/site/alarm/config/detail

请求参数：

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
alarmName	String	要查看的报警策略名	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/detail?
alarmName=b87ffe8c1c584b09b2baf15e6244d55d

响应示例

                JSON
                
            

                {
    "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
    "comment": "",
    "userId": "453bf9588c9e488f9ba2c984129090dc",
    "alarmName": "b87ffe8c1c584b09b2baf15e6244d55d",
    "namespace": "BCM_SITE",
    "level": "MAJOR",
    "actionEnabled": true,
    "incidentActions": [
        "cb15e004-c9c5-4498-8ba0-20319161a1c6"
    ],
    "resumeActions": ["cb15e004-c9c5-4498-8ba0-20319161a1c6"],
    "insufficientActions": [],
    "insufficientCycle": 0,
    "rules": [
        {
            "id": null,
            "index": 0,
            "metric": "redirectTime",
            "metricAlias": "重定向时间",
            "statistics": "average",
            "threshold": "100",
            "comparisonOperator": ">",
            "cycle": 300,
            "count": 2,
            "function": "THRESHOLD",
            "sequence": 0,
            "actOnIdcs": [
                "average",
                "shaanxi-CHINANET",
                "shaanxi-UNICOM",
                "shaanxi-CMNET",
                "jiangsu-CMNET"
            ],
            "actOnIsps": [],
            "versionSite": "PvwWOucRnClSYewY"
        }
    ],
    "region": "bj",
    "callbackUrl": "",
    "callbackToken": "",
    "method": "HTTP",
    "siteMonitor": "HTTP,lh_t_v1,http://baidu.com",
    "tag": ""
}
            

站点监控报警策略列表

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
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/list?
taskId=UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA&
pageNo=1&
pageSize=10

响应示例

                JSON
                
            

                {
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "result": [
        {
            "taskId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA",
            "comment": "",
            "userId": "453bf9588c9e488f9ba2c984129090dc",
            "alarmName": "bb_test",
            "namespace": "BCM_SITE",
            "level": "MAJOR",
            "actionEnabled": true,
            "incidentActions": [
                "lh_v1"
            ],
            "resumeActions": [],
            "insufficientActions": [],
            "insufficientCycle": 0,
            "rules": [
                {
                    "id": null,
                    "index": 0,
                    "metric": "redirectTime",
                    "metricAlias": "重定向时间",
                    "statistics": "average",
                    "threshold": "100",
                    "comparisonOperator": ">",
                    "cycle": 300,
                    "count": 2,
                    "function": "THRESHOLD",
                    "sequence": 0,
                    "actOnIdcs": [
                        "average",
                        "shaanxi-CHINANET",
                        "shaanxi-UNICOM",
                        "shaanxi-CMNET",
                        "jiangsu-CMNET"
                    ],
                    "actOnIsps": [],
                    "versionSite": "PvwWOucRnClSYewY"
                }
            ],
            "region": "bj",
            "callbackUrl": "",
            "callbackToken": "",
            "method": "HTTP",
            "siteMonitor": "HTTP,lh_t_v1,http://baidu.com",
            "tag": ""
        }
    ]
}
            

屏蔽站点报警策略

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
                
                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/block?
namespace=BCM_SITE&
alarmName=bb_test2

响应示例

                JSON
                
                {"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
                
                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/unblock?
namespace=BCM_SITE&
alarmName=bb_test2

响应示例

                JSON
                
                {"result":{},"success":true}

通过报警策略名获得站点任务信息接口

method：GET
URL：/csm/api/v1/userId/{userId}/site/alarm/config/{alarmName}

请求参数：

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
alarmName	String	报警策略名	是	path参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/bb_test

响应示例

                JSON
                
            

                {
    "name": "lh_t_v1",
    "address": "http://baidu.com",
    "method": "http",
    "siteId": "UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA"
}
            

整体概览相关接口

整体趋势图/探测点趋势图/运营商趋势图

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
                
            

                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/metricSiteData?metricName=totalTime&
statistics=average&
startTime=2021-04-16T07:05:00Z&
endTime=2021-04-16T07:10:00Z&
taskId=NsErRtUYHVtDRZYNfESnBfZLHjnflXsF&
cycle=60&
dimensions=beijing-UNICOM
            

返回示例

                JSON
                
            

                [
    {
        "namespace": "NsErRtUYHVtDRZYNfESnBfZLHjnflXsF___bj.BCM_SITE.453bf9588c9e488f9ba2c984129090dc",
        "dimensions": [
            {
                "name": "prov",
                "value": "beijing"
            },
            {
                "name": "isp",
                "value": "UNICOM"
            }
        ],
        "dataPoints": [
            {
                "timestamp": "2021-04-16T07:05:00Z"
            },
            {
                "timestamp": "2021-04-16T07:06:00Z"
            },
            {
                "timestamp": "2021-04-16T07:07:00Z"
            },
            {
                "timestamp": "2021-04-16T07:08:00Z"
            },
            {
                "timestamp": "2021-04-16T07:09:00Z"
            }
        ]
    }
]
            

整体视图接口

method：GET
URL：/csm/api/v1/userId/{userId}/site/idc/overallView

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JavaScript
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/idc/overallView?
taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH

响应示例

                JSON
                
            

                [
    {
        "id": "CMNET",
        "name": "移动",
        "availability": "0.0",
        "responseTime": 0.0
    },
    {
        "id": "UNICOM",
        "name": "联通",
        "availability": "0.0",
        "responseTime": 0.0
    },
    {
        "id": "CHINANET",
        "name": "电信",
        "availability": "0.0",
        "responseTime": 0.0
    }
]
            

分省视图接口

method：GET
URL：/csm/api/v1/userId/{userId}/site/idc/provincialView

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数
isp	String	运营商	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/idc/provincialView?
taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH&
isp=beijing

响应示例

                JSON
                
            

                [
    {
        "id": "beijing-UNICOM",
        "name": "北京联通",
        "availability": "98.33",
        "responseTime": 158.05084745762713
    }
]
            

探测点相关接口

探测点整理

省份	探测点名称
安徽	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
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/agent/list

响应示例

                JSON
                
            

                [
    {
        "agentId": "shaanxi-CMNET",
        "agentName": "陕西移动"
    },
    {
        "agentId": "heilongjiang-CMNET",
        "agentName": "黑龙江移动"
    },
    {
        "agentId": "jilin-CHINANET",
        "agentName": "吉林电信"
    },
    {
        "agentId": "henan-CMNET",
        "agentName": "河南移动"
    },
    {
        "agentId": "liaoning-CHINANET",
        "agentName": "辽宁电信"
    },
    {
        "agentId": "henan-UNICOM",
        "agentName": "河南联通"
    }
]
            

获取某个任务的探测点和运营商接口

method：GET

URL：/csm/api/v1/userId/{userId}/site/agent/idcIsp

请求参数

名称	类型	描述	是否必须	位置
userId	String	用户id	是	path参数
taskId	String	任务id	是	request参数

请求示例

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/agent/idcIsp?
taskId=BuqyMbmIgIBtAOBjWCCqkGBAJYYxlYrH

响应示例

                JSON
                
            

                {
    "idcs": [
        {
            "id": "average",
            "name": "全网均值"
        },
        {
            "id": "shanghai-CMNET",
            "name": "上海移动"
        },
        {
            "id": "beijing-UNICOM",
            "name": "北京联通"
        },
        {
            "id": "guangdong-CHINANET",
            "name": "广东电信"
        }
    ],
    "isps": [
        {
            "id": "CMNET",
            "name": "移动"
        },
        {
            "id": "CHINANET",
            "name": "电信"
        },
        {
            "id": "UNICOM",
            "name": "联通"
        }
    ]
}
            

事件监控

即时拨测

云监控 BCM

站点监控

站点监控任务配置相关接口

http(s)任务相关接口

http(s)任务创建

http(s)任务更新

http(s)任务详情

ping任务相关接口

ping任务创建

ping任务更新

ping任务详情

TCP任务相关接口

tcp任务创建

tcp任务更新

tcp任务详情

UDP任务相关接口

udp任务创建

udp任务更新

udp任务详情

ftp任务相关接口

ftp任务创建

ftp任务更新

ftp任务详情

dns任务相关接口

dns任务创建

dns任务更新

dns任务详情

站点监控任务列表接口

站点监控任务删除接口

站点监控任务查询接口

站点报警配置相关接口

创建站点监控报警策略

删除站点监控报警策略

更新站点监控报警策略

站点监控报警策略详情

站点监控报警策略列表

屏蔽站点报警策略

开启站点报警策略

通过报警策略名获得站点任务信息接口

整体概览相关接口

整体趋势图/探测点趋势图/运营商趋势图

整体视图接口

分省视图接口

探测点相关接口

探测点整理

获取所有探测点接口

获取某个任务的探测点和运营商接口