1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(ModifyNetDetect)用于修改网络探测参数。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyNetDetect。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NetDetectId | 是 | String | 网络探测实例ID 。形如:netd-12345678 示例值:netd-12345678 |
NetDetectName | 否 | String | 网络探测名称,最大长度不能超过60个字节。 示例值:test |
DetectDestinationIp.N | 否 | Array of String | 探测目的IPv4地址数组,最多两个。 示例值:["10.0.0.2\r\n","10.0.0.3\r\n"] |
NextHopType | 否 | String | 下一跳类型,目前我们支持的类型有: VPN:VPN网关; DIRECTCONNECT:专线网关; PEERCONNECTION:对等连接; NAT:NAT网关; NORMAL_CVM:普通云服务器; CCN:云联网网关; NONEXTHOP:无下一跳; 示例值: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; 下一跳类型为CCN,取值云联网ID,形如:ccn-12345678; 下一跳类型为NONEXTHOP,指定网络探测为无下一跳的网络探测; 示例值:10.0.0.4 |
NetDetectDescription | 否 | String | 网络探测描述。 示例值:test |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改网络探测
修改网络探测
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetDetect
<公共请求参数>
{
"NetDetectId": "netd-12345678",
"NetDetectName": "test",
"NextHopType": "NORMAL_CVM",
"NextHopDestination": "10.0.0.4",
"DetectDestinationIp": [
"10.0.0.3",
"10.0.0.2"
]
}
输出示例
{
"Response": {
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NetDetectTimeOut | 网络探测超时,请稍后重试。 |
InvalidParameter | 参数错误。 |
InvalidParameter.NextHopMismatch | 下一跳类型与下一跳网关不匹配。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.NetDetectNotFoundIp | 探测目的IP在云联网的路由表中找不到匹配的下一跳。 |
InvalidParameterValue.NetDetectSameIp | 探测目的IP与同一个私有网络内的同一个子网下的其他网络探测的探测目的IP相同。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation.ConflictWithDockerRoute | 与该VPC下的TKE容器的网段重叠。 |
UnsupportedOperation.EcmpWithUserRoute | 和用户自定义的路由形成ECMP。 |