操作指南

API文档

查询网络探测验证结果列表

最近更新时间:2022-01-27 09:32:51

我的收藏

1. 接口描述

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

本接口(DescribeNetDetectStates)用于查询网络探测验证结果列表。

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

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数
本文档展示的是V1签名的参数说明,腾讯云建议您使用安全系数更高的V3签名算法,使用签名方法 v3 时,公共参数需要统一放到 HTTP Header 请求头部中,详情

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

    3. 输出参数

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

    4. 示例

    示例1 根据ID查询网络探测验证结果列表

    输入示例

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

    输出示例

    {
      "Response": {
        "NetDetectStateSet": [
          {
            "NetDetectId": "netd-2owwwwd0",
            "NetDetectIpStateSet": [
              {
                "DetectDestinationIp": "10.0.0.2",
                "State": 0,
                "Delay": 0,
                "PacketLossRate": 0
              },
              {
                "DetectDestinationIp": "10.0.0.3",
                "State": 0,
                "Delay": 0,
                "PacketLossRate": 0
              }
            ]
          }
        ],
        "TotalCount": 1,
        "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.NetDetectTimeOut 网路探测超时,请稍后重试。
    InvalidParameter 参数错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    InvalidParameterValue.ResourceNotFound 未查询到该资源。
    ResourceNotFound 资源不存在。
    目录