調(diào)用DescribeVpnGateways接口查詢指定地域下已創(chuàng)建的VPN網(wǎng)關(guān)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:DescribeVpnGateways | list |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | VPN 網(wǎng)關(guān)所在的地域 ID。 您可以通過(guò)調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| VpcId | string | 否 | VPN 網(wǎng)關(guān)所屬專有網(wǎng)絡(luò) VPC（Virtual Private Cloud）的 ID。 | vpc-bp1m3i0kn1nd4wiw9**** |
| VpnGatewayId | string | 否 | VPN 網(wǎng)關(guān)的 ID。 | vpn-bp17lofy9fd0dnvzv**** |
| Status | string | 否 | VPN 網(wǎng)關(guān)的狀態(tài)。取值：
| active |
| BusinessStatus | string | 否 | VPN 網(wǎng)關(guān)的付費(fèi)狀態(tài)。取值：
| Normal |
| PageNumber | integer | 否 | 列表的頁(yè)碼。默認(rèn)值：1。 | 1 |
| PageSize | integer | 否 | 分頁(yè)查詢時(shí)每頁(yè)的條目數(shù)。取值范圍：1~50。默認(rèn)值：10。 | 10 |
| IncludeReservationData | boolean | 否 | 是否包含未生效的訂購(gòu)數(shù)據(jù)。取值：
| true |
| Tag | array<object> | 否 | VPN 網(wǎng)關(guān)綁定的標(biāo)簽列表。 | |
| object | 否 | VPN 網(wǎng)關(guān)綁定的標(biāo)簽。 | ||
| Key | string | 否 | 標(biāo)簽的標(biāo)簽鍵。一旦輸入該值，則不允許為空字符串。 最多支持 64 個(gè)字符，不能以 一次最多支持輸入 20 個(gè)標(biāo)簽鍵。 | FinanceDept |
| Value | string | 否 | 標(biāo)簽的標(biāo)簽值。 標(biāo)簽值最多支持 128 個(gè)字符，可以為空字符串，不能以 一個(gè)標(biāo)簽鍵對(duì)應(yīng)一個(gè)標(biāo)簽值。一次最多支持輸入 20 個(gè)標(biāo)簽值。 | FinanceJoshua |
| ResourceGroupId | string | 否 | VPN 網(wǎng)關(guān)所屬的資源組 ID。 您可以調(diào)用 ListResourceGroups 接口查詢資源組 ID。 | rg-acfmzs372yg**** |
返回參數(shù)
示例
正常返回示例
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": "中國(guó)站示例值：Prepay，國(guó)際站示例值：POSTPAY",
"VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
"Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"轉(zhuǎn)發(fā)1.3.7\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\"}",
"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****"
]
}
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的參數(shù)TagKey不合規(guī)范。 |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的參數(shù)TagValue不合規(guī)范。 |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的參數(shù)TagKey重復(fù)。 |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 內(nèi)部錯(cuò)誤 |
| 403 | Forbidden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您沒(méi)有權(quán)限操作該資源，請(qǐng)您申請(qǐng)操作權(quán)限后再試。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒(méi)有權(quán)限操作指定資源，請(qǐng)申請(qǐng)權(quán)限后再操作。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-06 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-06-30 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-05-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |