Site Monitor

Updated at：2025-11-03

HTTP(S) Task Creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/http/create 　　
　　　/csm/api/v1/userId/{userId}/site/https/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
httpTask	HttpTask	HTTP Task Information	Yes	Query Parameters

HttpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
method	String	Request Type (get/post)	Yes
postContent	String	Send Content	No
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
advanceConfig	Boolean	Whether to enable advanced configuration	Yes
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

When advanceConfig is true, the following parameters must be included

Name	Types	Description	Required or not
cookies	String	Request Cookie	No
host	String	Request Host	No
userAgent	String	Request UserAgent	No
responseCode	String	Expected Response Code	No
responseCheck	String	Expected Response Body	No
userName	String	Username	No
password	String	Password	No

Request example

                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
}    
            

Response example

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

HTTP(S) Task Update

method：PUT
URL：/csm/api/v1/userId/{userId}/site/http/update　
　　 /csm/api/v1/userId/{userId}/site/https/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
httpTask	HttpTask	HTTP Task Information	Yes	Query Parameters

HttpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Unique Task ID	Yes
address	String	Monitor URL	Yes
method	String	Request Type (get/post)	Yes
postContent	String	Send Content	No
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
advanceConfig	Boolean	Whether Advanced	Yes
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

When advanceConfig is true, the following parameters must be included

Name	Types	Description	Required or not
cookies	String	Request Cookie	No
host	String	Request Host	No
userAgent	String	Request UserAgent	No
responseCode	String	Expected Response Code	No
responseCheck	String	Expected Response Body	No
userName	String	Username	No
password	String	Password	No

Request example

                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
}
            

Response example

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

HTTP(S) Task Details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/http/detail?
taskId=BbjmjhalUMMeFXfZTUccWWEHchuMbewY

Response example

                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": "Shaanxi Mobile"
        },
        {
            "id": "heilongjiang-CMNET",
 "name": "Heilongjiang Mobile"
        },
        {
            "id": "liaoning-CMNET",
 "name": "Liaoning Mobile"
        },
        {
            "id": "jilin-CMNET",
 "name": "Jilin Mobile"
        },
        {
            "id": "henan-CMNET",
 "name": "Henan Mobile"
        }
    ],
    "timeout": 10,
    "advanceConfig": false,
    "method": "get",
    "postContent": "",
    "responseCode": "200",
    "responseCheck": "",
    "userName": "",
    "password": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

Ping Task Creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/ping/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
pingTask	PingTask	Ping Task Configuration	Yes	Query Parameters

PingTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
packetCount	int	Number of Packets Sent	No
packetLossRate	int	Packet Loss Rate	No
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

Ping Task Update

method：PUT
URL：/csm/api/v1/userId/{userId}/site/ping/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
pingTask	PingTask	Ping Task Configuration	Yes	Query Parameters

PingTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Task Unique Identifier	Yes
address	String	Monitor URL	Yes
packetCount	int	Number of Packets Sent	No
packetLossRate	int	Packet Loss Rate	No
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

Ping Task Details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                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": "Shaanxi Mobile"
        },
        {
            "id": "heilongjiang-CMNET",
 "name": "Heilongjiang Mobile"
        },
        {
            "id": "liaoning-CMNET",
 "name": "Liaoning Mobile"
        },
        {
            "id": "liaoning-UNICOM",
 "name": "Liaoning Unicom"
        },
        {
            "id": "jilin-UNICOM",
 "name": "Jilin Unicom"
        }
    ],
    "timeout": 10,
    "packetCount": 1,
    "packetLossRate": 6,
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

TCP Task Creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/tcp/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
tcpTask	TcpTask	TCP Task Configuration	Yes	Query Parameters

TcpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds (TCP supports timeout range [1，10])	Yes
advanceConfig	Boolean	Whether Advanced	Yes
port	int	Port No.	Yes
inputType	int	Input Type (1: Text 2: Hexadecimal Format 0: None)	Yes
outputType	int	Output Type (1: Text 2: Hexadecimal Format 0: None)	Yes
input	String	Request content	No
expectedOutput	String	Expected Output	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

TCP Task Update

method：PUT
URL：/csm/api/v1/userId/{userId}/site/tcp/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
tcpTask	TcpTask	TCP Task Configuration	Yes	Query Parameters

TcpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Unique Task ID	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds (TCP supports timeout range [1,10])	Yes
advanceConfig	Boolean	Whether Advanced	Yes
port	int	Port No.	Yes
inputType	int	Input Type (1: Text 2: Hexadecimal Format 0: None)	Yes
outputType	int	Output Type (1: Text 2: Hexadecimal Format 0: None)	Yes
input	String	Request content	No
expectedOutput	String	Expected Output	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

TCP task details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                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": "Shaanxi Mobile"
        },
        {
            "id": "heilongjiang-CMNET",
 "name": "Heilongjiang Mobile"
        },
        {
            "id": "liaoning-CMNET",
 "name": "Liaoning Mobile"
        },
        {
            "id": "liaoning-UNICOM",
 "name": "Liaoning Unicom"
        },
        {
            "id": "shanghai-UNICOM",
 "name": "Shanghai Unicom"
        }
    ],
    "timeout": 5,
    "advanceConfig": false,
    "port": 80,
    "inputType": 0,
    "outputType": 0,
    "input": "",
    "expectedOutput": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

UDP Task Creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/udp/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
udpTask	UdpTask	UDP Task Configuration	Yes	Query Parameters

UdpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
advanceConfig	Boolean	Whether Advanced	Yes
port	int	Port No.	Yes
inputType	int	Input Type (1: Text 2: Hexadecimal Format 0: None)	Yes
outputType	int	Output Type (1: Text 2: Hexadecimal Format 0: None)	Yes
input	String	Request content	No
expectedOutput	String	Expected Output	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

UDP Task Update

method：PUT
URL：/csm/api/v1/userId/{userId}}/site/udp/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
udpTask	UdpTask	UDP Task Configuration	Yes	Query Parameters

UdpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Unique Task ID	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
advanceConfig	Boolean	Whether Advanced	Yes
port	int	Port No.	Yes
inputType	int	Input Type (1: Text 2: Hexadecimal Format 0: None)	Yes
outputType	int	Output Type (1: Text 2: Hexadecimal Format 0: None)	Yes
input	String	Request content	No
expectedOutput	String	Expected Output	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

UDP Task Details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                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": "Shanghai Unicom"
        },
        {
            "id": "jiangsu-UNICOM",
 "name": "Jiangsu Unicom"
        },
        {
            "id": "chongqing-UNICOM",
 "name": "Chongqing Unicom"
        },
        {
            "id": "beijing-UNICOM",
 "name": "Beijing Unicom"
        },
        {
            "id": "ningxia-CMNET",
 "name": "Ningxia Mobile"
        }
    ],
    "timeout": 150,
    "port": 8081,
    "inputType": 0,
    "outputType": 0,
    "input": "",
    "expectedOutput": "",
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

FTP task creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/ftp/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
ftpTask	FtpTask	FTP task configuration	Yes	Query Parameters

FtpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
port	int	Ports	Yes
anonymousLogin	Boolean	Whether to log in anonymously	Yes
userName	String	Username	No
password	String	Password	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

FTP task update

method：PUT
URL：/csm/api/v1/userId/{userId}/site/ftp/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
ftpTask	FtpTask	FTP task configuration	Yes	Query Parameters

FtpTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Unique Task ID	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
port	int	Ports	Yes
anonymousLogin	Boolean	Whether to log in anonymously	Yes
userName	String	Username	No
password	String	Password	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

FTP Task Details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                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": "Shaanxi Mobile"
        },
        {
            "id": "heilongjiang-CMNET",
 "name": "Heilongjiang Mobile"
        },
        {
            "id": "hubei-CMNET",
 "name": "Hubei Mobile"
        },
        {
            "id": "guizhou-CMNET",
 "name": "Guizhou Mobile"
        },
        {
            "id": "shanxi-CMNET",
 "name": "Shanxi Mobile"
        }
    ],
    "timeout": 200,
    "port": 80,
    "anonymousLogin": true,
    "userName": "",
    "password": null,
    "ipType": "ipv4",
    "agentCount": 2,
    "agentTotalCount": 10
}
            

DNS Task Creation

method：POST
URL：/csm/api/v1/userId/{userId}/site/dns/create

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
dnsTask	DnsTask	DNS Task Configuration	Yes	Query Parameters

DnsTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
server	String	DNS server (No setup required if not needed)	Yes
resolveType	String	RECURSION: Recursive resolution; ITERATION: iterative resolution	Yes
kidnapWhite	String	Hijacking Allow List	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

DNS Task Update

method：PUT
URL：/csm/api/v1/userId/{userId}/site/dns/update

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
dnsTask	FtpTask	DNS Task Configuration	Yes	Query Parameters

DnsTask

Name	Types	Description	Required or not
taskName	String	Task name	Yes
taskId	String	Unique Task ID	Yes
address	String	Monitor URL	Yes
cycle	Integer	Detection Period	Yes
idc	String	Probe Points, separated by commas	Yes
timeout	int	Timeout Setting, in seconds	Yes
server	String	DNS server (No setup required if not needed)	Yes
resolveType	String	RECURSION: Recursive resolution; ITERATION: iterative resolution	Yes
kidnapWhite	String	Hijacking Allow List	No
ipType	String	Protocol Type (IPv4/IPv6)	Yes
agentCount	int	Uniformly set the count of probe points per provincial operator (1-5)	Yes

Request example

                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
}
            

Response example

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

DNS Task Details

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                JSON
                
            

                {
      "taskName": "pyy_dns_test",
      "address": "www.baidu.com",
      "cycle": 60,
      "idc": "beijing-CMNET",
      "idcObjs": [
            {
                  "id": "beijing-CMNET",
 "name": "Beijing Mobile"
            }
      ],
      "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
}
            

Site Monitor Task List API

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
query	String	Query parameters: when no search criteria exist, pass NAME:	No	Request Parameters
type	String	Task types: HTTP, TCP, etc.	No	Request Parameters
pageNo	int	Number of pages	Yes	Request Parameters
pageSize	int	Page size	Yes	Request Parameters

query

Types	Requires passing values	Example
Query by Name	NAME: value	NAME：test
As per monitor URL	TARGET: value	TARGET：www.baidu.com

Request example

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/list?
pageNo=1&
pageSize=10&
query=NAME:

Response example

                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
}
            

Site Monitor Task Deletion API

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                JSON
                
            

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

Site Monitor Task Query API

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
siteId	String	Site Task ID	Yes	Path Parameters

Request example

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

Response example

                JSON
                
            

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

Create Site Monitor Alarm Strategy

method：POST
URL：/csm/api/v1/userId/{userId}/site/alarm/config/create

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
alarmConfig	SiteAlarmConfig	Site Alarm Configuration	Yes	Query Parameters

SiteAlarmConfig

Name	Types	Description	Required or not
taskId	String	Task Unique Identifier	Yes
comment	String	Annotation	No
aliasName	String	Alarm Strategy Name	Yes
namespace	String	BCM_SITE	Yes
level	AlarmLevel	Alarm level: NOTICE, WARNING, CRITICAL, MAJOR, CUSTOM	Yes
actionEnabled	Boolean	Notification Status	Yes
resumeActions	Set	Recovery Action	Yes
insufficientActions	Set	No Data Action	Yes
insufficientCycle	int	No-data alarm judgment period	No
rules	List	Alarm Rule	Yes
region	String	Region	No
callbackUrl	String	Alarm callback address	No
callbackToken	String	Alarm callback token	No
method	String	Task type	No
siteMonitor	String	Monitor Object: Task Type + Task Name + Probe Address	No
tag	String	Identify old/new strategies, bmc2.0 indicates the old strategy	No
incidentAction	Set	Alarm action	Yes

SiteAlarmRule

Name	Types	Description	Required or not
metric	String	Name of metrics	Yes
metricAlias	String	Alias for metrics	Yes
statistics	String	average: mean value; max: maximum value; min: minimum value; sum: sum value	Yes
thresholed	String	Threshold	Yes
comparisonOperator	String	Comparison Method	Yes
cycle	int	Detection Period	Yes
count	int	Count	Yes
function	String	THRESHOLD: Normal Alarm CHAIN: MoM Alarm	Yes
actOnIdcs	List	Acting Probe Points	Yes
actOnIsps	List	Acting Operator	No
versionSite	String	Task Version	Not required for addition, but required for updates

Request example

                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": "Connection Establishment Time",
        "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 Resolution Time",
        "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": ""
}
            

Delete site monitor alarm strategy

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

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
alarmName	SiteAlarmNamesRequest	Alarm Strategy Name to Be Deleted	Yes	Query Parameters

SiteAlarmNamesRequest

Name	Types	Description	Required or not
alarmNames	List	List of Alarm Strategy Names to Be Deleted	Yes

Request example:

                JSON
                
            

                DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/delete
request body：
{
  "alarmNames":["b87ffe8c1c584b09b2baf15e6244d55d"]
}
            

Update site monitor alarm strategy

method：PUT
URL：/csm/api/v1/userId/{userId}/site/alarm/config/update

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
alarmConfig	SiteAlarmConfig	Site Alarm Configuration	Yes	Query Parameters

SiteAlarmConfig

Name	Types	Description	Required or not
taskId	String	Policy name	Yes
comment	String	Annotation	No
userId	String	User ID	Yes
alarmName	String	Alarm Strategy Name	Yes
namespace	String	BCM_SITE	Yes
level	AlarmLevel	Alarm level: NOTICE, WARNING, CRITICAL, MAJOR, CUSTOM	Yes
actionEnabled	Boolean	Notification Status	Yes
resumeActions	Set	Recovery Action	Yes
insufficientActions	Set	No Data Action	Yes
insufficientCycle	int	No-data alarm judgment period	No
rules	List	Alarm Rule	Yes
region	String	Region	No
callbackUrl	String	Alarm callback address	No
callbackToken	String	Alarm callback token	No
method	String	Task type	No
siteMonitor	String	Monitor Object: Task Type + Task Name + Probe Address	No
tag	String	Identify old/new strategies, bmc2.0 indicates the old strategy	No
incidentAction	Set	Alarm action	Yes

SiteAlarmRule

Name	Types	Description	Required or not
metric	String	Name of metrics	Yes
metricAlias	String	Alias for metrics	Yes
statistics	String	average: mean value; max: maximum value; min: minimum value; sum: sum value	Yes
thresholed	String	Threshold	Yes
comparisonOperator	String	Comparison Method	Yes
cycle	int	Detection Period	Yes
count	int	Count	Yes
function	String	THRESHOLD: Normal Alarm CHAIN: MoM Alarm	Yes
actOnIdcs	List	Acting Probe Points	Yes
actOnIsps	List	Acting Operator	No
versionSite	String	Task Version	Not required for addition, but required for updates

Request example:

                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": "Redirection time",
        "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": ""
}
            

Details of site monitor alarm strategy

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

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
alarmName	String	Alarm Strategy Name to Be Viewed	Yes	Request Parameters

Request example

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

Response example

                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": "Redirection time",
            "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": ""
}
            

Site Monitor Alarm Strategy List

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

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Site Monitor Task ID	No	Request Parameters
aliasName	String	Alarm Strategy Name	No	Request Parameters
actionEnabled	Boolean	Notification Status	No	Request Parameters
pageNo	int	Page number	Yes	Request Parameters
pageSize	int	Page size	Yes	Request Parameters

Request example

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/list?
taskId=UWeNWIjgqLUofLNfiXArVEQAdqKtkeEA&
pageNo=1&
pageSize=10

Response example

                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": "Redirection time",
                    "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": ""
        }
    ]
}
            

Disable Site Monitor Alarm Strategy

method：POST
URL：/csm/api/v1/userId/{userId}/site/alarm/config/block

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
namespace	String	BCM_SITE	Yes	Request Parameters
alarmName	String	Alarm Strategy Name	Yes	Request Parameters

Request example

                JSON
                
                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/block?
namespace=BCM_SITE&
alarmName=bb_test2

Response example

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

Enable Site Alarm Strategy

method：POST
URL：/csm/api/v1/userId/{userId}/site/alarm/config/unblock

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
namespace	String	BCM_SITE	Yes	Request Parameters
alarmName	String	Alarm Strategy Name	Yes	Request Parameters

Request example

                JSON
                
                POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/alarm/config/unblock?
namespace=BCM_SITE&
alarmName=bb_test2

Response example

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

API to Retrieve Site Task Information by Alarm Strategy Name

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

Request parameters:

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
alarmName	String	Alarm Strategy Name	Yes	Path Parameters

Request example

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

Response example

                JSON
                
            

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

Overall Trend Chart/Probe Point Trend Chart/Operator Trend Chart

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
metricName	String	Metric name	Yes	Request Parameters
statistics	String[]	Statistic Method	Yes	Request Parameters
startTime	String	UTC Time, Start Time	Yes	Request Parameters
endTime	String	UTC Time, End Time	Yes	Request Parameters
cycle	int	Period, default 60s	Yes	Request Parameters
taskId	String	Task ID	Yes	Request Parameters
dimensions	String	Dimension	No	Request Parameters

Dimensions Description

API	dimensions
Overall Trend Chart	Empty
Probe Point Trend Chart	beijing-UNICOM
Operator trend chart	UNICOM

Request example

                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
            

Response example

                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"
            }
        ]
    }
]
            

Overview API

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                JSON
                
            

                [
    {
        "id": "CMNET",
 "name": "Mobile",
        "availability": "0.0",
        "responseTime": 0.0
    },
    {
        "id": "UNICOM",
 "name": "Unicom",
        "availability": "0.0",
        "responseTime": 0.0
    },
    {
        "id": "CHINANET",
 "name": "Telecom",
        "availability": "0.0",
        "responseTime": 0.0
    }
]
            

Province-specific view API

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters
isp	String	Operator	Yes	Request Parameters

Request example

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

Response example

                JSON
                
            

                [
    {
        "id": "beijing-UNICOM",
 "name": "Beijing Unicom",
        "availability": "98.33",
        "responseTime": 158.05084745762713
    }
]
            

Probe Point Organization

Province	Probe Point Name
Anhui	anhui
Beijing	beijing
Fujian	fujian
Gansu	gansu
Guangdong	guangdong
Guangxi	guangxi
Guizhou	guizhou
Hainan	hainan
Hebei	hebei
Henan	henan
Heilongjiang	heilongjiang
Hubei	hubei
Hunan	hunan
Jilin	jilin
Jiangsu	jiangsu
Jiangxi	jiangxi
Liaoning	liaoning
Inner Mongolia	neimenggu
Ningxia	ningxia
Qinghai	qinghai
Shandong	shandong
Shanxi	shanxi
Shaanxi	shanxi
Shanghai	shanghai
Sichuan	sichuan
Tianjin	tianjin
Tibet	xizang
Xinjiang	xinjiang
Yunnan	yunnan
Zhejiang	zhejiang
Chongqing	chongqing

Operator	Name
Telecom	CHINANET
mobile	CMNET
Unicom	UNICOM

Note: Probe points exist except for Jilin Mobile, Tibet Unicom, and Tibet Mobile

API to Retrieve All Probe Points

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

Request parameters

Name	Types	Description	Required or not	Location
userId	String	User ID	Yes	Path Parameters

Request example:

                JSON
                
                GET /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/site/agent/list

Response example

                JSON
                
            

                [
    {
        "agentId": "shaanxi-CMNET",
 "agentName": "Shaanxi Mobile"
    },
    {
        "agentId": "heilongjiang-CMNET",
 "agentName": "Heilongjiang Mobile"
    },
    {
        "agentId": "jilin-CHINANET",
 "agentName": "Jilin Telecom"
    },
    {
        "agentId": "henan-CMNET",
 "agentName": "Henan Mobile"
    },
    {
        "agentId": "liaoning-CHINANET",
 "agentName": "Liaoning Telecom"
    },
    {
        "agentId": "henan-UNICOM",
 "agentName": "Henan Unicom"
    }
]
            

API to Retrieve the Probe Point and Operator for a Task

method：GET

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

Request parameters

Name	Types	Description	Required or not	Location
userId	String	User ID	Yes	Path Parameters
taskId	String	Task ID	Yes	Request Parameters

Request example

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

Response example

                JSON
                
            

                {
    "idcs": [
        {
            "id": "average",
 "name": "Network-wide Average"
        },
        {
            "id": "shanghai-CMNET",
 "name": "Shanghai Mobile"
        },
        {
            "id": "beijing-UNICOM",
 "name": "Beijing Unicom"
        },
        {
            "id": "guangdong-CHINANET",
 "name": "Guangdong Telecom"
        }
    ],
    "isps": [
        {
            "id": "CMNET",
 "name": "Mobile"
        },
        {
            "id": "CHINANET",
 "name": "Telecom"
        },
        {
            "id": "UNICOM",
 "name": "Unicom"
        }
    ]
}
            

Instance Group Interface

Query Latest Metric Data for Partial Dimensions

BCM

BCM

Site Monitor

Site Monitor Task Configuration Related APIs

HTTP(S) Task Related API

HTTP(S) Task Creation

HTTP(S) Task Update

HTTP(S) Task Details

Ping Task Related APIs

Ping Task Creation

Ping Task Update

Ping Task Details

TCP Task Related APIs

TCP Task Creation

TCP Task Update

TCP task details

UDP Task Related APIs

UDP Task Creation

UDP Task Update

UDP Task Details

FTP task-related APIs

FTP task creation

FTP task update

FTP Task Details

DNS Task Related APIs

DNS Task Creation

DNS Task Update

DNS Task Details

Site Monitor Task List API

Site Monitor Task Deletion API

Site Monitor Task Query API

Site Monitor Alarm Configuration Related APIs

Create Site Monitor Alarm Strategy

Delete site monitor alarm strategy

Update site monitor alarm strategy

Details of site monitor alarm strategy

Site Monitor Alarm Strategy List

Disable Site Monitor Alarm Strategy

Enable Site Alarm Strategy

API to Retrieve Site Task Information by Alarm Strategy Name

Overview Related APIs

Overall Trend Chart/Probe Point Trend Chart/Operator Trend Chart

Overview API

Province-specific view API

Probe node-related APIs

Probe Point Organization

API to Retrieve All Probe Points

API to Retrieve the Probe Point and Operator for a Task