調用CreateVpnAttachment接口創建IPsec連接,用于綁定轉發路由器實例。
接口說明
調用CreateVpnAttachment
接口創建的 IPsec 連接默認未綁定任何資源,后續您可以通過調用 CreateTransitRouterVpnAttachment 接口將 IPsec 連接綁定轉發路由器實例。
前提條件
創建 IPsec 連接前,請確保您已經在 IPsec 連接所在的地域創建了用戶網關。具體操作,請參見 CreateCustomerGateway 。
如果您需要為 IPsec 連接添加 BGP 配置,請確保用戶網關已添加了自治系統號。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:CreateVpnAttachment | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPsec 連接所屬的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
Name | string | 否 | IPsec 連接的名稱。 名稱長度為 1~100 個字符,不能以 | nametest |
CustomerGatewayId | string | 否 | 用戶網關 ID。 | cgw-p0w2jemrcj5u61un8**** |
NetworkType | string | 否 | IPsec 連接的網絡類型。取值:
| public |
LocalSubnet | string | 是 | 需要和本地數據中心互通的 VPC 側的網段,用于第二階段協商。 多個網段之間用半角逗號(,)分隔,例如:192.168.1.0/24,192.168.2.0/24。 關于 IPsec 連接路由模式的說明:
| 10.1.1.0/24,10.1.2.0/24 |
RemoteSubnet | string | 是 | 需要和 VPC 互通的本地數據中心側的網段,用于第二階段協商。 多個網段之間用半角逗號(,)分隔,例如:192.168.3.0/24,192.168.4.0/24。 關于 IPsec 連接路由模式的說明:
| 10.1.3.0/24,10.1.4.0/24 |
EffectImmediately | boolean | 否 | 選擇 IPsec 連接的配置是否立即生效。 取值:
| false |
IkeConfig | string | 否 | 第一階段協商的配置信息:
| {"Psk":"1234****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"47.XX.XX.1","RemoteId":"47.XX.XX.2"} |
IpsecConfig | string | 否 | 第二階段協商的配置信息:
| {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
BgpConfig | string | 否 | BGP 的配置信息:
說明
| {"EnableBgp":"true","LocalAsn":"45104","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"} |
HealthCheckConfig | string | 否 | 健康檢查配置信息:
| {"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3","Policy": "revoke_route"} |
AutoConfigRoute | boolean | 否 | 是否自動配置路由。取值:
| true |
EnableDpd | boolean | 否 | 是否開啟 DPD(對等體存活檢測)功能。取值:
| true |
EnableNatTraversal | boolean | 否 | 是否開啟 NAT 穿越功能。取值:
| true |
RemoteCaCert | string | 否 | 國密型 VPN 網關創建 IPsec 連接時,對端的 CA 證書。 | -----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 123e4567-e89b-12d3-a456-4266**** |
Tags | array<object> | 否 | IPsec 連接待添加的標簽列表。 一次最多支持為 IPsec 連接添加 20 個標簽。 | |
object | 否 | 標簽信息。 | ||
Key | string | 否 | 標簽鍵。一旦輸入該值,則不允許為空字符串。 最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽鍵。 | TagKey |
Value | string | 否 | 標簽值。 標簽值最多支持 128 個字符,可以為空字符串,不能以 一個標簽鍵對應一個標簽值。一次最多支持輸入 20 個標簽值。 | TagValue |
ResourceGroupId | string | 否 | IPsec 連接所屬的資源組 ID。
| rg-acfmzs372yg**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "88187252-0E26-3C4D-9D1D-32A04454EBBA",
"VpnConnectionId": "vco-p0wb09rama8qwwgfn****",
"Name": "nametest",
"CreateTime": 1658201810000,
"Code": "200",
"Message": "successful",
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Resource.QuotaFull | The quota of resource is full | 資源配額已達上限。 |
400 | InvalidVpnConnection.AlreadyExists | Vpn connection already exists. | VPN 連接已經存在,不用再次添加。 |
400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | 該路由已存在。 |
400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 路由條目存在沖突。 |
400 | NotSupportVpnConnectionParameter.IpsecPfs | The specified vpn connection ipsec Ipsec Pfs is not support. | IPsec連接中指定的Pfs參數不支持 |
400 | NotSupportVpnConnectionParameter.IpsecAuthAlg | The specified vpn connection ipsec Auth Alg is not support. | IPsec連接中指定的認證算法不支持 |
400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | 主備路由條目校驗失敗。 |
400 | VpnRouteEntry.InvalidWeight | Invalid route entry weight value. | 路由權重值不合法 |
400 | InvalidParameter.VpnConnectionName | The specified vpn connection name is invalid. | 指定的VPN連接名稱不合規范。 |
400 | QuotaExceeded.PolicyBasedRoute | The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s. | 策略路由條數已達上限,當前已有%s條,本次將創建%s條,上限為%s條。 |
400 | MissingParameter.TunnelCidr | The parameter TunnelCidr is mandatory when BGP is enabled. | 開啟BGP時,隧道CIDR參數是必填項 |
400 | OperationUnsupported.EnableBgp | Current region does not support enable BGP. | 當前地域不支持開啟BGP。 |
400 | MissingParam.CustomerGatewayAsn | Asn of customer gateway is mandatory when BGP is enabled. | 開啟BGP時,客戶網關的自治系統號不可以為空。 |
400 | IllegalParam.LocalAsn | The specified LocalAsn is invalid. | 本端自治系統號不合法。 |
400 | InvalidParameter.BgpConfig | The specified BgpConfig is invalid. | 指定的BGP配置不合規范 |
400 | IllegalParam.EnableBgp | VPN connection must enable BGP when VPN gateway has enabled BGP. | 當 VPN 網關啟用 BGP 時,VPN 連接必須啟用 BGP。 |
400 | IllegalParam.TunnelCidr | The specified TunnelCidr is invalid. | 參數TunnelCidr不合法。 |
400 | InvalidLocalBgpIp.Malformed | The specified LocalBgpIp is malformed. | 指定的本端BGP的IP異常 |
400 | IllegalParam.LocalBgpIp | The specified LocalBgpIp is invalid. | 本端BGP地址不合法。 |
400 | IllegalParam.LocalSubnet | The specified "LocalSubnet" (%s) is invalid. | 本端網段(%s)不合法。 |
400 | IllegalParam.RemoteSubnet | The specified "RemoteSubnet" (%s) is invalid. | 對端網段(%s)不合法。 |
400 | OperationFailed.MissCertificate | The VPN connecton has not associated any certificates. | 當前VPN連接沒有關聯任何證書。 |
400 | MissingParam.RemoteId | The remote ID is mandatory when creating national standard VPN connection. | 當創建國密VPN連接時,對端ID是必填參數。 |
400 | CustomerGateway.ConflictRouteEntry | The specified customer gateway has conflict with route entry. | 當前用戶網關和路由存在沖突。 |
400 | VpnTask.CONFLICT | Vpn task has conflict. | Vpn操作存在沖突,請稍后重試。 |
400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 標簽資源重復 |
400 | OperationFailed.NoAvailableAmount | The available amount of your account is less than 0, please recharge before attempting to purchase. | 您的賬戶可用額度小于0,請先充值后再嘗試購買。 |
400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 標簽數量超限 |
400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的參數TagValue不合規范。 |
400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的參數TagKey不合規范。 |
400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的參數TagKey重復。 |
400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內部錯誤 |
400 | InvalidTunnelCidr.Malformed | The specified TunnelCidr is malformed. | 指定的隧道CIDR異常 |
400 | CustomerGateway.ConflictVpnIp | The customer gateway associated with the IPSec connection should not have the same IP address as the VPN gateway. | IPSec連接關聯的用戶網關與VPN網關不應該有相同的網關IP地址。 |
400 | MissingParameter.TunnelOptionsSpecification | The required parameters are missing when creating a tunnel for dual-tunnel VPN. | 雙隧道VPN在創建隧道時,必填參數缺失。 |
400 | CreateDbrRoutesQuotaFull.QuotaFull | The number of created destination routes exceeds the quota limit. | 創建目的路由數量超過配額限制。 |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您沒有權限操作該資源,請您申請操作權限后再試。 |
403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源,請申請權限后再操作。 |
404 | InvalidCustomerGatewayInstanceId.NotFound | The specified customer gateway instance id does not exist. | 指定的用戶網關實例不存在,請您檢查用戶網關實例ID是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-11-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-11-25 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-10-24 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-05-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-10-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-08-09 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |