Tenant Cloud Network Virtual Private Cloud Network Probe APIs DescribeNetDetects

DescribeNetDetects

Last Updated At: 2026-08-02 00:06:19

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeNetDetects) is used to query the network probe list.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-11-14 04:52:05.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeNetDetects
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
NetDetectIds No No Array of String An array of network detection instance IDs, such as [netd-demoag78].
Example: netd-demoag78
Filters No No Array of Filter Filtering conditions. The parameters NetDetectIds and Filters cannot be specified simultaneously.
  • vpc-id - String - (filtering condition) VPC instance ID, such as vpc-demoag78.
  • net-detect-id - String - (filtering condition) network detection instance ID, such as netd-demoag78.
  • subnet-id - String - (filtering condition) subnet instance ID, such as subnet-demoag78.
  • net-detect-name - String - (filtering condition) network detection name.

    • Example:View
    Offset No No Uint64 Offset. 0 by default.
    Example: 0
    Limit No No Uint64 Number of returns, 20 by default, up to 100.
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    NetDetectSet Array of NetDetect Eligible network probe object array.
    Example:View
    TotalCount Uint64 Number of eligible network probe objects.
    Example:
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.Malformed Invalid input format.
    ResourceNotFound The resource does not exist
    InvalidParameter.Coexist The parameters must not be specified simultaneously.
    InvalidParameterValue.Range The parameter value is not within the specified range.