1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CreateHaVip) is used to create a HAVIP.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-26 04:15:21.
The interface is both signature verification and authentication.
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: CreateHaVip |
| 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 | VPC ID of HAVIP. Example: vpc-6v2ht8q5 |
| SubnetId | Yes | No | String | Subnet ID of HAVIP. Example: subnet-qq51iwr4 |
| HaVipName | Yes | No | String | HAVIP name. Example: demo+name |
| Vip | No | No | String | Specifies a virtual IP address, which must fall under the VPC IP range and must not be occupied. If not specified, it will be automatically allocated. Example: 10.4.6.15 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| HaVip | HaVip | HAVIP object. Example:View |
| IsCdc | Uint64 | Whether it is a CDC type HAVIP. Example: |
| CheckAssociate | Bool | Whether HAVIP drift range verification is enabled. Example: |
| FlushedTime | String | HAVIP refresh time. This parameter is used only as an output parameter. The refresh of FlushTime will be triggered by the following scenarios: (1) The instance sends a gratuitous ARP to trigger HAVIP drift. (2) Manually unbind the HAVIP from the ENI. The default value is 0000-00-00 00:00:00 when there is no update. Example: |
| Visible | Bool | Whether the HAVIP is visible to the tenant. Example: |
| CdcId | String | CDC instance ID. Example: |
| 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. |
| LimitExceeded | Exceeded the limit |
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.Duplicate | Input Parameters are repetitive. |
| InvalidParameterValue.TooLong | Invalid input: Excessive length of the parameter. |