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.
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
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: DescribeNetDetects. |
| 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. |
| NetDetectIds.N | No | Array of String | The array of network detection instance 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, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
&Version=2017-03-12
&<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"
}
}https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
&Version=2017-03-12
&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. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?