Domain name for API request: vpc.intl.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.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
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. |
Offset | No | Integer | The offset. Default: 0. |
Limit | No | Integer | The number of returned values. Default: 20. Maximum: 100. |
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query all network probes.
https://vpc.intl.tencentcloudapi.com/?Action=DescribeNetDetects
&<common request parameters>
{
"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"
}
}
This example shows you how to query network probes by IDs.
https://vpc.intl.tencentcloudapi.com/?Action=DescribeNetDetects
&NetDetectIds.0=netd-12345678
&<common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | The parameter value is invalid. |
InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
InvalidParameterValue.Malformed | Invalid input parameter format. |
InvalidParameterValue.NotUtf8EncodingError | |
InvalidParameterValue.Range | The parameter value is not in the specified range. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?