调用CreateHaVip接口创建高可用虚拟IPHaVip_专有网络VPC-阿里云帮助中心

使用说明

CreateHaVip接口属于异步接口，即系统会返回一个实例ID，但该HaVip尚未创建完成，系统后台的创建任务仍在进行。您可以调用DescribeHaVips查询HaVip的创建状态：

当HaVip处于Creating状态时，表示HaVip正在创建中。
当HaVip处于Available状态时，表示HaVip创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Name	String	否	test	HaVip实例的名称。名称长度为1～128个字符，不能以`http://`或`https://`开头。
Action	String	是	CreateHaVip	系统规定参数。取值：CreateHaVip。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe637760	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
RegionId	String	是	cn-hangzhou	HaVip实例所在的地域。您可以通过调用DescribeRegions接口获取地域ID。
VSwitchId	String	是	vsw-asdfjlnaue4g****	HaVip实例所属的交换机ID。
IpAddress	String	否	192.XX.XX.10	HaVip实例的IP地址。指定的IP地址必须为交换机网段中未被占用的IP地址。如果不指定，则从指定的交换机中随机分配一个未被占用的IP地址。
Description	String	否	This is my HaVip.	HaVip实例的描述信息。描述长度为1～256个字符，不能以`http://`或`https://`开头。
ResourceGroupId	String	否	rg-acfmxazb4ph6aiy****	高可用虚拟IP所属的资源组ID。

返回数据


名称	类型	示例值	描述
RequestId	String	C44F62BE-9CE7-4277-B117-69243F3988BF	请求ID。
IpAddress	String	192.XX.XX.10	HaVip实例的IP地址。
HaVipId	String	havip-2zeo05qre24nhrqpy****	HaVip实例的ID。

示例

请求示例

http(s)://[Endpoint]/?Name=test
&Action=CreateHaVip
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&RegionId=cn-hangzhou
&VSwitchId=vsw-asdfjlnaue4g****
&IpAddress=192.XX.XX.10
&Description=This is my HaVip.
&ResourceGroupId=rg-acfmxazb4ph6aiy****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateHaVipResponse>
    <RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId>
    <IpAddress>192.XX.XX.10</IpAddress>
    <HaVipId>havip-2zeo05qre24nhrqpy****</HaVipId>
</CreateHaVipResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C44F62BE-9CE7-4277-B117-69243F3988BF",
  "IpAddress" : "192.XX.XX.10",
  "HaVipId" : "havip-2zeo05qre24nhrqpy****"
}

错误码


HttpCode	错误码	错误信息	描述
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	操作HaVip没有权限，请到配额中心申请权限。
400	InvalidDescription.Malformed	The specified Description is wrongly formed.	入参Description无效
400	InvalidIPAddress.OutOfRange	The specified IPAddress is out of VSwitch CIDR.	该私网IP不在交换机网段内。
400	InvalidIPAddress.NotAvailable	The specified IPAddress is not available because it is a system reserved IPAddress.	该IP不可用，该IP是系统预留IP。
400	InvalidIPAddress.AlreadyUsed	The specified IPAddress is already used by other resource.	该IP已经被占用。
400	InvalidIPAddress.Malformed	The specified IPAddress is not a valid or strict address.	传入的IP地址不合法。
400	InvalidIPAddress.OutOfVswCIDR	The specified IPAddress is out of VSwitch CIDR.	指定的IP地址超出虚拟交换机（VSwitch）的CIDR段
400	InvalidIPAddress.AlreadyInUse	The specified IPAddress is already used by other resource.	指定的IP地址已经被其他资源使用
400	UnsupportedFeature.CloudBoxHaVip	The HAVIP feature is not supported in cloud box.	云盒不支持创建高可用vip。
400	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.	超过指定VPC的HAVIP配额。
403	QuotaExceeded.HaVip	Living HaVip quota exceeded.	超过活跃的HAVIP配额。
404	InvalidRegionId.NotFound	Specified value of "regionId" is not supported.	指定的 RegionId 不存在，请您检查此产品在该地域是否可用。
404	InvalidVSwitchId.NotFound	The specified VSwitch does not exist in the specified region.	该交换机在该地域内不存在。

访问错误中心查看更多错误码。