tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyNetDetect

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

1. API Description

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

This API (ModifyNetDetect) is used to modify network detection parameters.

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: ModifyNetDetect.
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.
NetDetectId Yes String The ID of a network detection instance, such as netd-12345678.
NetDetectName No String The name of a network detection instance. The maximum length is 60 characters.
DetectDestinationIp.N No 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
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the parameters of a network probe

This example shows you u200dhow to modify the parameters of a network probe.

Input Example

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

{
    "NetDetectId": "netd-12345678",
    "NetDetectName": "test",
    "NextHopType": "NORMAL_CVM",
    "NextHopDestination": "10.0.0.4",
    "DetectDestinationIp": [
        "10.0.0.3",
        "10.0.0.2"
    ]
}

Output Example

{
    "Response": {
        "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.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.TooLong Invalid parameter value. The parameter value is too long.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnsupportedOperation.EcmpWithUserRoute Form an ECMP with the user’s custom routes.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy