調用CreateHaVip接口創建高可用虛擬IP（HaVip）。
接口說明
CreateHaVip 接口屬于異步接口，即系統會返回一個實例 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 個字符，不能以 | 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～256 個字符，不能以 | This is my HaVip. |
| ResourceGroupId | string | 否 | 高可用虛擬 IP 所屬的資源組 ID。 | rg-acfmxazb4ph6aiy**** |
| Tag | array<object> | 否 | 資源的標簽。 | |
| object | 否 | 標簽。 | ||
| Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | FinanceJoshua |
返回參數
示例
正常返回示例
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. | 入參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 | Abs.Vpc.InvalidName.Malformed | The specified Name is not valid. | 傳入的Name無效 |
| 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配額。 |
| 400 | Forbidden.HaVip | No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance. | 操作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. | 該交換機在該地域內不存在。 |
| 404 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. | 指定的資源組非法或不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-09-06 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |