調用CreateCustomerGateway接口創建用戶網關。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreateCustomerGateway | create | *CustomerGateway acs:vpc:{#regionId}:{#accountId}:customergateway/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 用戶網關所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 由客戶端生成該參數值，要保證在不同請求間唯一，最大值不超過 64 個 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11e9-8e44**** |
| IpAddress | string | 是 | 本地數據中心網關設備的公網 IP 地址。 | 101.12.XX.XX |
| Name | string | 否 | 用戶網關的名稱。 名稱長度為 1～100 個字符，不能以 | nametest |
| Description | string | 否 | 用戶網關的描述信息。 描述信息長度為 1～100 個字符，不能以 | desctest |
| Asn | string | 否 | 本地數據中心網關設備的自治系統號。 Asn 是一個 4 字節的號碼，支持按照兩段位的格式進行輸入，即：前 16 位比特.后 16 位比特。每個段位使用十進制輸入。 例如輸入 123.456，則表示自治系統號：123*65536+456=8061384。 | 65530 |
| AuthKey | string | 否 | 本地數據中心網關設備 BGP 路由協議的認證密鑰。 密鑰長度為 1~64 個字符，只支持 ASCII 字符，不支持空格、中文和半角問號（?）。 | AuthKey**** |
| Tags | array<object> | 否 | 用戶網關待添加的標簽列表。 一次最多支持為用戶網關添加 20 個標簽。 | |
| object | 否 | 標簽信息。 | ||
| Key | string | 否 | 標簽鍵。一旦輸入該值，則不允許為空字符串。 最多支持 64 個字符，不能以 一次最多支持輸入 20 個標簽鍵。 | TagKey |
| Value | string | 否 | 標簽值。 標簽值最多支持 128 個字符，可以為空字符串，不能以 一個標簽鍵對應一個標簽值。一次最多支持輸入 20 個標簽值。 | TagValue |
| ResourceGroupId | string | 否 | 用戶網關所屬的資源組 ID。
| rg-aek2qo2h4jy**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
"IpAddress": "101.12.XX.XX",
"Description": "desctest",
"CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
"CreateTime": 1493363486000,
"Name": "nametest"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidAuthkey.Malformed | The specified BGP authentication key (%s) is malformed. | 該BGP認證密鑰不合法。 |
| 400 | InvalidIpAddress.AlreadyExist | Specified IpAddress is already exist. | 該IP地址已經存在。原因是同一個用戶在同一個地域內，IP地址不可重復。 |
| 400 | InvalidIpAddress.WrongFormat | Specified IpAddress is invalid. | 該IP不合法。 |
| 400 | InvalidName | The name is not valid | 該名稱格式不合法。 |
| 400 | InvalidDescription | The description is not valid | 描述格式不合法。 |
| 400 | Resource.QuotaFull | The quota of resource is full | 資源配額已達上限。 |
| 400 | IllegalParam.Asn | The specified Asn is invalid. | 指定的Asn不合規范。 |
| 400 | OperationDenied.MissingAsn | The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. | 當指定了用戶網關的BGP驗證密鑰時，必須指定自治系統號。 |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的參數TagValue不合規范。 |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 標簽數量超限 |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 標簽資源重復 |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的參數TagKey不合規范。 |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的參數TagKey重復。 |
| 400 | OperationFailed.NoRamPermission | Vpn Service has no permission to operate your IDaaS instances. | Vpn服務沒有權限操作您的IDaaS實例 |
| 400 | CreateVpnUserGatewayQuotaFull.QuotaFull | The number of created VPN customer gateways exceeds the quota. | 創建VPN用戶網關數量超出配額。 |
| 403 | Forbidden.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. | 您沒有權限操作指定資源，請申請權限后再操作。 |
| 409 | OperationConflict | The operation against this instance is too frequent, please try again later. | 對該實例的操作過于頻繁，請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |