调用DescribeVpnGateways接口查询指定地域下已创建的VPN网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeVpnGateways | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 标签的标签键。一旦输入该值,则不允许为空字符串。 最多支持 64 个字符,不能以 一次最多支持输入 20 个标签键。 | FinanceDept |
Value | string | 否 | 标签的标签值。 标签值最多支持 128 个字符,可以为空字符串,不能以 一个标签键对应一个标签值。一次最多支持输入 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.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****"
]
}
}
]
}
}
错误码
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 错误码发生变更 | 查看变更详情 |