IPv6網關是控制專有網絡VPC(Virtual Private Cloud)的IPv6網絡流量的網關。您可以通過調用CreateIpv6Gateway接口創建IPv6網關。
接口說明
-
創建 IPv6 網關之前,請確保目標 VPC 和交換機已開通 IPv6 網段能力,您可以調用 DescribeVpcAttribute ,查詢 VPC 的配置信息。
-
一個 VPC 內僅允許創建一個 IPv6 網關。
-
CreateIpv6Gateway 接口屬于異步接口,即系統返回一個實例 ID,但該 IPv6 網關尚未創建成功,系統后臺的啟動任務仍在進行。您可以調用 DescribeIpv6GatewayAttribute 查詢 IPv6 網關的創建狀態:
- 當 IPv6 網關處于 Creating 狀態時,表示 IPv6 網關正在創建中。
- 當 IPv6 網關處于 Created 狀態時,表示 IPv6 網關創建完成。
-
CreateIpv6Gateway 接口不支持在同一個 VPC 下并發創建 IPv6 網關。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:CreateIpv6Gateway | create | *Ipv6Gateway acs:vpc:{#regionId}:{#accountId}:ipv6gateway/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPv6 網關的地域 ID。您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-huhehaote |
VpcId | string | 是 | 要開通 IPv6 網關的 VPC ID。 | vpc-123sedrfswd23**** |
Name | string | 否 | IPv6 網關的名稱。 長度為 0-128 個字符,不能以 | ipv6GW |
Description | string | 否 | IPv6 網關的描述信息。 長度為 0-256 個字符,不能以 | ipv6gatewayforVPC1 |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
ResourceGroupId | string | 否 | IPv6 網關所屬的資源組 ID。 關于資源組的更多信息,請參見什么是資源組。 | rg-acfmxazb4ph6aiy**** |
Tag | array<object> | 否 | 資源的標簽。 | |
object | 否 | 標簽。 | ||
Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值,則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值,可以輸入空字符串。 最多支持 128 個字符,不能以 | FinanceJoshua |
返回參數
示例
正常返回示例
JSON
格式
{
"Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidVpcId.NotFound | %s | - |
400 | IllegalParam.Name | %s | - |
400 | IllegalParam.Description | %s | - |
400 | IllegalParam.Spec | %s | - |
400 | IllegalParam.ChargeType | %s | - |
400 | OperationUnsupported.OnlyOneIpv6GatewayInVpc | %s | - |
400 | OperationFailed.VpcIpv6Disabled | %s | - |
400 | OperationFailed.UnpaidBillsExist | The account has unpaid bills. Please pay your overdue bill first. | 此賬戶有未支付的訂單。 |
400 | OperationFailed.InformationIncomplete | Your information is incomplete. | 輸入信息不完整。 |
400 | OperationFailed.NoPaymentMethod | No payment method is specified for your account. | 賬戶中沒有有效的支付方式。 |
400 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. | 指定的資源組非法或不存在 |
400 | MissingParam.vpcId | The parameter vpcId is mandatory. | 參數缺失,vpcId是必選參數 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
404 | InvalidVpcId.NotFound | Specified VPC does not exist. | 該VPC不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-07-05 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |