1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CheckNetDetectState) is used for network probe verification.
Default interface request rate limit: 100 times per second.
Interface update time: 2020-04-03 05:38:28.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CheckNetDetectState |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| NetDetectId | No | No | String | The network detection instance ID, such as netd-demoag78. This parameter requires at least one of the following: VpcId, SubnetId, or NetDetectName. If NetDetectId is provided, it takes precedence. Example: netd-demoag78 |
| VpcId | No | No | String | VPC instance ID, such as vpc-demoag78. This parameter is used in conjunction with SubnetId and NetDetectName, and at least one of these should be specified along with NetDetectId. If NetDetectId is provided, it takes precedence.Example: vpc-7zayowkt |
| SubnetId | No | No | String | The subnet instance ID, such as subnet-demoag78. This parameter is used in conjunction with VpcId and NetDetectName, and at least one of these should be specified along with NetDetectId. If NetDetectId is provided, it takes precedence. Example: subnet-siqkaiqm |
| NetDetectName | No | No | String | Network probe name, up to 60 bytes in length. This parameter is used in conjunction with (VpcId, SubnetId), and at least one of NetDetectId and this parameter must be provided. When NetDetectId exists, it will be used. Example: name |
| DetectDestinationIp | Yes | No | Array of String | Probe destination IPv4 address array. The maximum number is two. Example: ["10.0.0.2\r\n","10.0.0.3\r\n"] |
| NextHopType | Yes | No | String | Type of next hop. Types currently supported are VPN: VPN gateway; DIRECTCONNECT: Direct Connect gateway; PEERCONNECTION: Peering connection; NAT: NAT gateway; NORMAL_CVM: Ordinary CVM. Example: NORMAL_CVM |
| NextHopDestination | Yes | No | String | The next hop target gateway, with valid values depending on the next hop type: When the next hop type is VPN, the value should be the VPN gateway ID, such as vpngw-demoag78. When the next hop type is DIRECTCONNECT, the value should be the Direct Connect gateway ID, such as dcg-demoag78. When the next hop type is PEERCONNECTION, the value should be the peering connection ID, such as pcx-demoag78. When the next hop type is NAT, the value should be the NAT gateway, such as nat-demoag78. When the next hop type is NORMAL_CVM, the value should be the CVM IPv4 address, such as 10.0.0.12. Example: 10.0.0.4 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| NetDetectIpStateSet | Array of NetDetectIpState | Network probe validation result object array. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameter | Invalid input parameters. |
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.TooLong | Invalid input: Excessive length of the parameter. |
| MissingParameter | Missing parameters. The request did not carry the required parameter. |
| UnsupportedOperation.VpcMismatch | The resources do not belong to the same VPC. |
| InvalidParameter.NextHopMismatch | The next hop type does not match it's gateway. |
| InvalidParameterValue.NetDetectSameIp | The probe destination IP is the same as that of another network probe within the same VPC and subnet. |