Domain name for API request: vpc.tencentcloudapi.com.
This API is used to create a network detection instance.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: CreateNetDetect. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| VpcId | Yes | String | The ID of a VPC instance, such as vpc-12345678. |
| SubnetId | Yes | String | The ID of a subnet instance, such as subnet-12345678. |
| NetDetectName | Yes | String | The name of a network detection instance. The maximum length is 60 characters. |
| DetectDestinationIp.N | Yes | Array of String | The array of detection destination IPv4 addresses, which contains at most two IP addresses. |
| NextHopType | Yes | String | The type of the next hop. Currently supported types are: VPN: VPN gateway; DIRECTCONNECT: direct connect gateway; PEERCONNECTION: peering connection; NAT: NAT gateway; NORMAL_CVM: normal CVM. |
| NextHopDestination | Yes | String | The next-hop destination gateway. The value is related to NextHopType. If NextHopType is set to VPN, the value of this parameter is the VPN gateway ID, such as vpngw-12345678. If NextHopType is set to DIRECTCONNECT, the value of this parameter is the direct connect gateway ID, such as dcg-12345678. If NextHopType is set to PEERCONNECTION, the value of this parameter is the peering connection ID, such as pcx-12345678. If NextHopType is set to NAT, the value of this parameter is the NAT gateway ID, such as nat-12345678. If NextHopType is set to NORMAL_CVM, the value of this parameter is the IPv4 address of the CVM, such as 10.0.0.12. |
| NetDetectDescription | No | String | Network detection description. |
| Parameter Name | Type | Description |
|---|---|---|
| NetDetect | NetDetect | The network detection (NetDetect) object. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=CreateNetDetect
&Version=2017-03-12
&VpcId=vpc-12345678
&SubnetId=subnet-12345678
&NetDetectName=test
&DetectDestinationIp.0=10.0.0.2
&DetectDestinationIp.1=10.0.0.3
&NextHopType=NORMAL_CVM
&NextHopDestination=10.0.0.4
&<Common request parameters>{
"Response": {
"NetDetect": {
"VpcId": "vpc-12345678",
"VpcName": "vpc-test",
"SubnetId": "subnet-12345678",
"SubnetName": "subnet-test",
"NetDetectId": "netd-12345678",
"NetDetectName": "test",
"DetectDestinationIp": [
"10.0.0.2",
"10.0.0.3"
],
"DetectSourceIp": [
"10.0.0.5",
"10.0.0.6"
],
"NextHopType": "NORMAL_CVM",
"NextHopDestination": "10.0.0.4",
"NextHopName": "",
"NetDetectDescription": "",
"CreateTime": "0000-00-00 00:00:00"
},
"RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter | Invalid input parameter. |
| InvalidParameter.NextHopMismatch | The next hop type does not match with the next hop gateway. |
| InvalidParameterValue | Invalid parameter value |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.NetDetectSameIp | The detection destination IP address is the same as that of another network detection instance under the same subnet in the same VPC. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| LimitExceeded | Quota limit is reached. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation.VpcMismatch | The resources are not in the same VPC. |
Was this page helpful?