CreateHaVip - Virtual Private Cloud

呼叫 CreateHaVip 介面建立高可用虛擬 IP（HaVip）。

介面說明

CreateHaVip 介面屬於非同步介面，即系統會返回 HaVip 的 ID，但該 HaVip 尚未建立完成，系統後台的建立任務仍在進行。您可以呼叫 DescribeHaVips 查詢 HaVip 的建立狀態：

當 HaVip 處於 Creating 狀態時，表示 HaVip 正在建立中。
當 HaVip 處於 Available 狀態時，表示 HaVip 建立完成。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:CreateHaVip

create

*HaVip

acs:vpc:{#regionId}:{#accountId}:havip/*

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	HaVip 的名稱。名稱長度為 1～128 個字元，不能以`http://`或`https://`開頭。	test
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	是	HaVip 所在的地域。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
VSwitchId	string	是	HaVip 所屬的交換機 ID。	vsw-asdfjlnaue4g****
IpAddress	string	否	HaVip 的 IP 位址。指定的 IP 位址必須為交換機網段中未被佔用的 IP 位址。如果不指定，則從指定的交換機中隨機分配一個未被佔用的 IP 位址。	192.XX.XX.10
Description	string	否	HaVip 的描述資訊。描述長度為 1～255 個字元，不能以`http://`或`https://`開頭。	This is my HaVip.
ResourceGroupId	string	否	HaVip 所屬的資源群組 ID。	rg-acfmxazb4ph6aiy****
Tag	array<object>	否	資源的標籤。
	object	否	標籤。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入空字串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入空字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	返回資訊。
RequestId	string	請求 ID。	C44F62BE-9CE7-4277-B117-69243F3988BF
IpAddress	string	HaVip 的 IP 位址。	192.XX.XX.10
HaVipId	string	HaVip 的 ID。	havip-2zeo05qre24nhrqpy****

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidDescription.Malformed	The specified Description is wrongly formed.
400	InvalidIPAddress.OutOfRange	The specified IPAddress is out of VSwitch CIDR.
400	InvalidIPAddress.NotAvailable	The specified IPAddress is not available because it is a system reserved IPAddress.
400	InvalidIPAddress.AlreadyUsed	The specified IPAddress is already used by other resource.
400	InvalidIPAddress.Malformed	The specified IPAddress is not a valid or strict address.
400	Abs.Vpc.InvalidName.Malformed	The specified Name is not valid.
400	InvalidIPAddress.OutOfVswCIDR	The specified IPAddress is out of VSwitch CIDR.
400	InvalidIPAddress.AlreadyInUse	The specified IPAddress is already used by other resource.
400	UnsupportedFeature.CloudBoxHaVip	The HAVIP feature is not supported in cloud box.
400	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.
400	OperationDenied.InvalidIpReservedByVSwitch	The specified ip address is the reserved address of the switch.
400	InvalidRegionId.NotFound	Specified value of "regionId" is not supported.
400	IllegalParam.ResourceGroupId	Invalid ResourceGroupld value.
400	IncorrectStatus.VSwitch	The specified vSwitch status is invalid.
403	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.
403	QuotaExceeded.HaVip	Living HaVip quota exceeded.
404	InvalidVSwitchId.NotFound	The specified VSwitch does not exist in the specified region.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。