租户端 网络 私有网络（VPC） 网络探测相关接口 CheckNetDetectState

CheckNetDetectState

最近更新时间: 2024-12-21 13:01:34

1. 接口描述

接口请求域名： vpc.api3.gsesgpucloud.com。

本接口(CheckNetDetectState)用于验证网络探测。

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

接口更新时间：2020-04-01 21:38:28。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CheckNetDetectState
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
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 下一跳类型，目前我们支持的类型有：
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；
示例值：

3. 输出参数

参数名称 类型 描述
NetDetectIpStateSet NetDetectIpState 网络探测验证结果对象数组。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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