tencent cloud



Last updated: 2022-08-24 17:36:18

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Params. The value used for this API: CreateNetDetect.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. 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 No String Type of the next hop. Valid values:
VPN: VPN gateway;
DIRECTCONNECT: direct connect gateway;
PEERCONNECTION: peering connection;
NAT: NAT gateway;
CCN: CCN gateway.
NextHopDestination No String Next-hop destination gateway. Its value is determined by NextHopType.
If NextHopType is set to VPN, the parameter value is the VPN gateway ID, such as vpngw-12345678.
If NextHopType is set to DIRECTCONNECT, the parameter value is the direct connect gateway ID, such as dcg-12345678.
If NextHopType is set to PEERCONNECTION, the parameter value is the peering connection ID, such as pcx-12345678.
If NextHopType is set to NAT, the parameter value is the NAT gateway ID, such as nat-12345678.
If NextHopType is set to NORMAL_CVM, the parameter value is the IPv4 address of the CVM instance, such as
If NextHopType is set to CCN, the parameter value is the CCN ID, such as ccn-12345678.
NetDetectDescription No String Network detection description.

3. Output Parameters

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.

4. Example

Example1 Creating a network probe

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "NetDetect": {
            "VpcId": "vpc-12345678",
            "VpcName": "vpc-test",
            "SubnetId": "subnet-12345678",
            "SubnetName": "subnet-test",
            "NetDetectId": "netd-12345678",
            "NetDetectName": "test",
            "DetectDestinationIp": [
            "DetectSourceIp": [
            "NextHopType": "NORMAL_CVM",
            "NextHopDestination": "",
            "NextHopName": "",
            "NetDetectDescription": "",
            "CreateTime": "0000-00-00 00:00:00"
        "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.NetDetectTimeOut Network probe timed out. Please retry later.
InvalidParameter A parameter error occurred.
InvalidParameter.NextHopMismatch The next hop type does not match with the next hop gateway.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.NetDetectInVpc The probe destination IP and network probe are in the same VPC.
InvalidParameterValue.NetDetectNotFoundIp Unable to find the matched next hop in the CCN route table for the destination IP.
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.ResourceNotFound This resource is not found.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
ResourceInsufficient Insufficient resources.
ResourceNotFound The resource does not exist.
UnsupportedOperation.ConflictWithDockerRoute The IP range overlaps with that of the TKE container under the VPC.
UnsupportedOperation.EcmpWithUserRoute Form an ECMP with the user’s custom routes.
UnsupportedOperation.VpcMismatch The resources are not in the same VPC.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support