tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNetDetects

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

1. API Description

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

This API (DescribeNetDetects) is used to query the list of network detection instances.

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: DescribeNetDetects.
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.
NetDetectIds.N No Array of String The array of network probe IDs, such as [netd-12345678].
Filters.N No Array of Filter Filter conditions. NetDetectIds and Filters cannot be specified at the same time.
  • vpc-id - String - (Filter condition) The VPC instance ID, such as vpc-12345678.
  • net-detect-id - String - (Filter condition) The network detection instance ID, such as netd-12345678.
  • subnet-id - String - (Filter condition) The subnet instance ID, such as subnet-12345678.
  • net-detect-name - String - (Filter condition) The network detection name.
    		•
    Offset No Integer The offset. Default: 0.
    Limit No Integer The number of returned values. Default: 20. Maximum: 100.

    3. Output Parameters

    Parameter Name Type Description
    NetDetectSet Array of NetDetect The array of network detection objects that meet requirements.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer The number of network detection objects that meet requirements.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying all network probes

    This example shows you how to query all network probes.

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
&<common request parameters>

    Output Example

    {
    "Response": {
        "NetDetectSet": [
            {
                "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"
            },
            {
                "VpcId": "vpc-12345678",
                "VpcName": "vpc-test",
                "SubnetId": "subnet-12345678",
                "SubnetName": "subnet-test",
                "NetDetectId": "netd-12345679",
                "NetDetectName": "test",
                "DetectDestinationIp": [
                    "10.0.1.2",
                    "10.0.1.3"
                ],
                "DetectSourceIp": [
                    "10.0.1.5",
                    "10.0.1.6"
                ],
                "NextHopType": "NORMAL_CVM",
                "NextHopDestination": "10.0.0.4",
                "NextHopName": "",
                "NetDetectDescription": "",
                "CreateTime": "0000-00-00 00:00:00"
            }
        ],
        "TotalCount": 2,
        "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
    }
}

    Example2 Querying network probes by IDs

    This example shows you how to query network probes by IDs.

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
&NetDetectIds.0=netd-12345678
&<common request parameters>

    Output Example

    {
    "Response": {
        "NetDetectSet": [
            {
                "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"
            }
        ],
        "TotalCount": 1,
        "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
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameter.FilterInvalidKey The specified filter condition does not exist.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy