验证网络探测
最近更新时间: 2024-10-18 10:38:47
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口(CheckNetDetectState)用于验证网络探测。
默认接口请求频率限制：100次/秒。
接口更新时间：2020-04-01 21:38:28。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CheckNetDetectState |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| NetDetectId | 否 | 否 | String | 网络探测实例ID。形如：netd-12345678。该参数与（VpcId，SubnetId，NetDetectName），至少要有一个。当NetDetectId存在时，使用NetDetectId。 |
| VpcId | 否 | 否 | String | VPC实例ID。形如：vpc-12345678。该参数与（SubnetId，NetDetectName）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。 |
| SubnetId | 否 | 否 | String | 子网实例ID。形如：subnet-12345678。该参数与（VpcId，NetDetectName）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。 |
| NetDetectName | 否 | 否 | String | 网络探测名称，最大长度不能超过60个字节。该参数与（VpcId，SubnetId）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。 |
| DetectDestinationIp | 是 | 否 | Array of String | 探测目的IPv4地址数组，最多两个。 |
| NextHopType | 是 | 否 | String | 下一跳类型，目前我们支持的类型有：<br>VPN：VPN网关；<br>DIRECTCONNECT：专线网关；<br>PEERCONNECTION：对等连接；<br>NAT：NAT网关；<br>NORMAL_CVM：普通云服务器； |
| NextHopDestination | 是 | 否 | String | 下一跳目的网关，取值与“下一跳类型”相关：<br>下一跳类型为VPN，取值VPN网关ID，形如：vpngw-12345678；<br>下一跳类型为DIRECTCONNECT，取值专线网关ID，形如：dcg-12345678；<br>下一跳类型为PEERCONNECTION，取值对等连接ID，形如：pcx-12345678；<br>下一跳类型为NAT，取值Nat网关，形如：nat-12345678；<br>下一跳类型为NORMAL_CVM，取值云服务器IPv4地址，形如：10.0.0.12； |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NetDetectIpStateSet | NetDetectIpState | 此参数对外不可见。 网络探测验证结果对象数组。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| InvalidParameterValue.Malformed | |
| ResourceNotFound | |
| InvalidParameterValue.TooLong | |
| MissingParameter | |
| UnsupportedOperation.VpcMismatch | |
| InvalidParameter.NextHopMismatch | |
| InvalidParameterValue.NetDetectSameIp |