CheckNetDetectState

Last updated: 2020-05-15 11:12:18

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.

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

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 parameter. The value used for this API: CheckNetDetectState.
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.
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 ID of a network detection instance

Input Example

https://vpc.tencentcloudapi.com/?Action=CheckNetDetectState
&Version=2017-03-12
&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"
  }
}

Example2 Verifying the detection parameters based on the entered information

Input Example

https://vpc.tencentcloudapi.com/?Action=CheckNetDetectState
&Version=2017-03-12
&VpcId=vpc-12345678
&SubnetId=subnet-12345678
&NetDetectName=test
&DetectDestinationIp.0=10.0.0.5
&DetectDestinationIp.1=10.0.0.6
&NextHopType=NORMAL_CVM
&NextHopDestination=10.0.0.4
&<Common request parameters>

Output Example

{
  "Response": {
    "NetDetectIpStateSet": [
      {
        "DetectDestinationIp": "10.0.0.5",
        "State": 0,
        "Delay": 0,
        "PacketLossRate": 0
      },
      {
        "DetectDestinationIp": "10.0.0.6",
        "State": 0,
        "Delay": 0,
        "PacketLossRate": 0
      }
    ],
    "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
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.
MissingParameter Parameter missing. A required parameter is missing in the request.
ResourceNotFound The resource does not exist.
UnsupportedOperation.VpcMismatch The resources are not in the same VPC.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help