调用DescribeVpnGateway接口查询指定VPN网关的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeVpnGateway | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VPN 网关所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
VpnGatewayId | string | 是 | VPN 网关实例 ID。 | vpn-bp1r3v1xqkl0w519g**** |
IncludeReservationData | boolean | 否 | 是否包含未生效的订单数据。取值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"VpnType": "Normal",
"Status": "init",
"VpcId": "vpc-bp19m2yx1m5q0avyq****",
"SslMaxConnections": 5,
"Spec": "5",
"InternetIp": "47.22.XX.XX",
"CreateTime": 1495382400000,
"AutoPropagate": true,
"ChargeType": "中国站示例值:Prepay,国际站示例值:POSTPAY",
"VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
"Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
"IpsecVpn": "enable",
"EndTime": 1544666102000,
"VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
"RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
"Description": "vpngatewaydescription",
"EnableBgp": true,
"BusinessStatus": "Normal",
"SslVpn": "enable",
"Name": "vpngatewayname",
"ReservationData": {
"Status": "1",
"ReservationOrderType": "TEMP_UPGRADE",
"ReservationIpsec": "enable",
"ReservationSpec": "5",
"ReservationSsl": "enable",
"ReservationMaxConnections": 5,
"ReservationEndTime": "2020-07-20T16:00:00Z"
},
"Tags": {
"Tag": [
{
"Key": "aaa",
"Value": "bbb"
}
]
},
"NetworkType": "public",
"DisasterRecoveryInternetIp": "47.91.XX.XX",
"DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
"SslVpnInternetIp": "47.74.XX.XX",
"ResourceGroupId": "rg-acfmzs372yg****",
"EniInstanceIds": {
"EniInstanceId": [
"eni-7xvcxgmd4y2ypibn****"
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-06 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-06-30 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |