API文档

查询网络探测列表

最近更新时间:2020-07-13 08:52:08

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeNetDetects)用于查询网络探测列表。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeNetDetects。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
NetDetectIds.N Array of String 网络探测实例ID数组。形如:[netd-12345678]
Filters.N Array of Filter 过滤条件,参数不支持同时指定NetDetectIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-12345678
  • net-detect-id - String - (过滤条件)网络探测实例ID,形如:netd-12345678
  • subnet-id - String - (过滤条件)子网实例ID,形如:subnet-12345678
  • net-detect-name - String - (过滤条件)网络探测名称
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    NetDetectSet Array of NetDetect 符合条件的网络探测对象数组。
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 符合条件的网络探测对象数量。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询所有网络探测

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
    &Version=2017-03-12
    &<公共请求参数>

    输出示例

    {
      "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"
      }
    }

    示例2 根据ID查询网络探测

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeNetDetects
    &Version=2017-03-12
    &NetDetectIds.0=netd-12345678
    &<公共请求参数>

    输出示例

    {
      "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. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue 参数值不合法。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    目录