調用DescribeVpnGateways接口查詢指定地域下已創建的VPN網關。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:DescribeVpnGateways | list | *VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/**VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnInstanceId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網關所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| VpcId | string | 否 | VPN 網關所屬專有網絡 VPC（Virtual Private Cloud）的 ID。 | vpc-bp1m3i0kn1nd4wiw9**** |
| VpnGatewayId | string | 否 | VPN 網關的 ID。 | vpn-bp17lofy9fd0dnvzv**** |
| Status | string | 否 | VPN 網關的狀態。取值：
| active |
| BusinessStatus | string | 否 | VPN 網關的付費狀態。取值：
| Normal |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的條目數。取值范圍：1~50。默認值：10。 | 10 |
| IncludeReservationData | boolean | 否 | 是否包含未生效的訂購數據。取值：
| true |
| Tag | array<object> | 否 | VPN 網關綁定的標簽列表。 | |
| object | 否 | VPN 網關綁定的標簽。 | ||
| Key | string | 否 | 標簽鍵。 一次最多支持輸入 20 個標簽鍵。 | FinanceDept |
| Value | string | 否 | 標簽值。 一個標簽鍵對應一個標簽值。一次最多支持輸入 20 個標簽值。 | FinanceJoshua |
| ResourceGroupId | string | 否 | VPN 網關所屬的資源組 ID。 您可以調用 ListResourceGroups 接口查詢資源組 ID。 | rg-acfmzs372yg**** |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
"PageNumber": 1,
"TotalCount": 1,
"VpnGateways": {
"VpnGateway": [
{
"VpnType": "Normal",
"Status": "active",
"VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
"SslMaxConnections": 5,
"Spec": "5M",
"InternetIp": "47.12.XX.XX",
"CreateTime": 1515383700000,
"AutoPropagate": true,
"ChargeType": "中國站示例值：Prepay，國際站示例值：POSTPAY",
"VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
"Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"轉發1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
"IpsecVpn": "enable",
"EndTime": 1518105600000,
"VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
"Description": "test",
"EnableBgp": true,
"BusinessStatus": "Normal",
"SslVpn": "enable",
"Name": "test",
"NetworkType": "public",
"Tags": {
"Tag": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
},
"ReservationData": {
"Status": "1",
"ReservationOrderType": "TEMP_UPGRADE",
"ReservationIpsec": "enable",
"ReservationSpec": "5",
"ReservationSsl": "enable",
"ReservationMaxConnections": 5,
"ReservationEndTime": "2021-07-20T16:00:00Z"
},
"DisasterRecoveryInternetIp": "47.91.XX.XX",
"DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
"SslVpnInternetIp": "47.74.XX.XX",
"ResourceGroupId": "rg-acfmzs372yg****",
"EniInstanceIds": {
"EniInstanceId": [
"eni-7xvcxgmd4y2ypibn****"
]
}
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的參數TagKey不合規范。 |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的參數TagValue不合規范。 |
| 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. | 內部錯誤 |
| 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. | 您沒有權限操作指定資源，請申請權限后再操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-06-30 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |