Create Network Probe
Updated at：2025-10-16
Description
Set up a network probe.
Request structure
Plain Text
1POST /v{version}/probe?clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "name":"test",
6 "description":"desc",
7 "vpcId":"vpc-sf52s4f7s1d",
8 "subnetId":"sbn-dtzcawikg1g2",
9 "protocol":"UDP",
10 "frequency":10,
11 "sourceIpNum":2,
12 "sourceIps":["192.168.0.1"],
13 "destIp":"10.0.5.8"，
14 "destPort":80,
15 "payload":"test"
16}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | For API version No., the current value is 1 |
| clientToken | String | No | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits, see details in [ClientToken Idempotence](VPC/API Reference/General Description.md#Idempotence). |
| name | String | Yes | RequestBody | Network probe name, no more than 65 characters, available to consist of numbers, letters, and underscores |
| description | String | No | RequestBody | Network probe description, not exceeding 200 characters |
| vpcId | String | Yes | RequestBody | VPC ID to which the network probe belongs |
| subnetId | String | Yes | RequestBody | Subnet ID to which the network probe belongs |
| protocol | String | Yes | RequestBody | Probe type, currently supporting ICMP, TCP, UDP, and DNS |
| frequency | Integer | Yes | RequestBody | Value range of probe frequency: 10, 20, 30 |
| sourceIps | List<String> | Yes | RequestBody | List of probe source IPs (can be left empty; if empty, the sourceIpNum must be specified) |
| sourceIpNum | Integer | No | RequestBody | Number of automatically assigned probe source IPs |
| destIp | String | Yes | RequestBody | Probe destination IP |
| destPort | Integer | No | RequestBody | Probe destination port (mandatory for TCP, UDP, and DNS types) |
| payload | String | No | RequestBody | Probe string for UDP type and probe domain name for DNS type |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| probeId | String | Network probe ID |
Request example
Plain Text
1POST /v1/ probe?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "name":"22",
6 "description":"description",
7 "vpcId":"vpc-7vh8yaemjt48",
8 "subnetId":"sbn-tzgpvbmuk69d",
9 "sourceIpNum":1,
10 "sourceIps":[
11 "10.101.168.1"
12 ],
13 "destIp":"8.8.8.8",
14 "frequency":20,
15 "protocol":"UDP",
16 "destPort":80,
17 "payload":"udp_probe"
18}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "probeId": "probe-s2kyrsdnvk287ziu",
8}