tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CheckNetDetectState

最后更新时间：2023-07-11 17:48:38

1. API Description

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

This API is used to verify the network detection status.

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: CheckNetDetectState.
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.
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.
NetDetectId No String ID of a network inspector instance, e.g. netd-12345678. Enter at least one of this parameter, VpcId, SubnetId, and NetDetectName. Use NetDetectId if it is present.
VpcId No String ID of a VPC instance, e.g. vpc-12345678, which is used together with SubnetId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present.
SubnetId No String ID of a subnet instance, e.g. subnet-12345678, which is used together with VpcId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present.
NetDetectName No String The name of a network inspector, up to 60 bytes in length. It is used together with VpcId and NetDetectName. You should enter either this parameter or NetDetectId, or both. Use NetDetectId if it is present.

3. Output Parameters

Parameter Name Type Description
NetDetectIpStateSet Array of NetDetectIpState The array of network detection verification results.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Verifying the detection parameters based on the network probe ID.

Input Example

https://vpc.tencentcloudapi.com/?Action=CheckNetDetectState
&NetDetectId=netd-12345678
&DetectDestinationIp.0=10.0.0.2
&DetectDestinationIp.1=10.0.0.3
&NextHopType=NORMAL_CVM
&NextHopDestination=10.0.0.4
&<Common request parameters>

Output Example

{
    "Response": {
        "NetDetectIpStateSet": [
            {
                "DetectDestinationIp": "10.0.0.2",
                "State": 0,
                "Delay": 0,
                "PacketLossRate": 0
            },
            {
                "DetectDestinationIp": "10.0.0.3",
                "State": 0,
                "Delay": 0,
                "PacketLossRate": 0
            }
        ],
        "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.
MissingParameter Missing parameter.
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.
隐私条款服务条款缓存条款