1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
Determine if an IP is available in a subnet
Default interface request rate limit: 20 times per second.
Interface update time: 2023-07-06 20:23:35.
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: CheckIpInSubnet |
| 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 |
| VpcId | Yes | No | String | VPCID Example: vpc-67wlqf6v |
| SubnetId | Yes | No | String | Subnet instance ID. Example: subnet-8qywqc4y |
| PrivateIpAddresses | Yes | No | Array of String | VPC IP address Example: 10.2.3.64 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| message | String | message. ok indicates success. Example: ok |
| 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 |
|---|---|
| ResourceNotFound | The resource does not exist |
| ResourceInUse.Address | The specified IP address is already in use. |
| InvalidParameterValue.Range | The parameter value is not within the specified range. |