修改网络探测

最近更新时间:2019-12-05 18:03:10

1. 接口描述

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

本接口(ModifyNetDetect)用于修改网络探测参数。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyNetDetect
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
NetDetectId String 网络探测实例ID。形如:netd-12345678
NetDetectName String 网络探测名称,最大长度不能超过60个字节。
DetectDestinationIp.N Array of String 探测目的IPv4地址数组,最多两个。
NextHopType String 下一跳类型,目前我们支持的类型有:
VPN:VPN网关;
DIRECTCONNECT:专线网关;
PEERCONNECTION:对等连接;
NAT:NAT网关;
NORMAL_CVM:普通云服务器;
NextHopDestination String 下一跳目的网关,取值与“下一跳类型”相关:
下一跳类型为VPN,取值VPN网关ID,形如:vpngw-12345678;
下一跳类型为DIRECTCONNECT,取值专线网关ID,形如:dcg-12345678;
下一跳类型为PEERCONNECTION,取值对等连接ID,形如:pcx-12345678;
下一跳类型为NAT,取值Nat网关,形如:nat-12345678;
下一跳类型为NORMAL_CVM,取值云服务器IPv4地址,形如:10.0.0.12;
NetDetectDescription String 网络探测描述。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改网络探测参数

输入示例

https://vpc.tencentcloudapi.com/?Action=ModifyNetDetect
&Version=2017-03-12
&NetDetectId=netd-12345678
&NetDetectName=test
&DetectDestinationIp.0=10.0.0.2
&DetectDestinationIp.1=10.0.0.3
&NextHopType=NORMAL_CVM
&NextHopDestination=10.0.0.4
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 入参不合法。
InvalidParameter.NextHopMismatch 下一跳类型与下一跳网关不匹配。
InvalidParameterValue 参数值不合法。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.NetDetectSameIp 探测目的IP与同一个私有网络内的同一个子网下的其他网络探测的探测目的IP相同。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
MissingParameter 参数缺失。请求没有带必选参数。
ResourceNotFound 资源不存在。