tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateNetDetect

Last updated: 2023-08-23 14:11:23

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create a network probe.

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 No String Common Params. This parameter is not required for this API.
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;
NORMAL_CVM: CVM instance;
CCN: CCN instance;
NONEXTHOP: No next hop.
NextHopDestination No String ID of the next-hop gateway.
If NextHopType is set to VPN, the value of this parameter is the VPN gateway ID, such as vpngw-12345678.
NextHopType = DIRECTCONNECT: Direct connect gateway ID, such as dcg-12345678.
NextHopType = PEERCONNECTION: Peering connection ID, such as pcx-12345678.
NextHopType = NAT: 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.
NextHopType = CCN: CCN instance ID, such as ccn-12345678.
NextHopType = NONEXTHOP: No next hop.
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

This example shows you how to create a network probe.

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNetDetect
<Common request parameters>

{
    "VpcId": "vpc-12345678",
    "NextHopDestination": "10.0.0.4",
    "NextHopType": "NORMAL_CVM",
    "NetDetectName": "test",
    "DetectDestinationIp": [
        "10.0.0.3",
        "10.0.0.2"
    ],
    "SubnetId": "subnet-12345678"
}

Output Example

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

5. Developer Resources

SDK

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 Unsupported operation.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy