调用DescribeVpnGateways查询满足指定条件的VPN网关。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVpnGateways | 要执行的操作,取值:DescribeVpnGateways |
Version | String | 是 | 2020-04-01 | API版本信息。 |
PageSize | Integer | 否 | 20 | 查询结果的分页大小。最大值:100,默认值:20。 |
PageNumber | Integer | 否 | 1 | 查询结果的页码。
|
VpnGatewayIds.N | List of String | 否 | VpnGatewayIds.1=vgw-3tehy14c6c0v****&VpnGatewayIds.2=vgw-fg655nh68**** | VPN网关的ID。
|
VpnGatewayName | String | 否 | VpnGateway-test | VPN网关的名称。 |
VpcId | String | 否 | vpc-3tijjfd0ul4bwbhc**** | VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。 |
SubnetId | String | 否 | subnet-3tijjfftzh4bwbhc**** | VPN网关所在子网的ID。您可调用DescribeSubnets查询子网的ID信息。 |
IpAddress | String | 否 | 22.XX.XX.18 | VPN网关的出口IP地址。 |
ProjectName | String | 否 | Project_1 | VPN网关所属的项目。
|
TagFilters.N.Key | String | 否 | TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3 | 云资源实例的标签键(Key)。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3 | 云资源实例的标签值(Value)。
|
IPsecEnabled | Boolean | 否 | true | IPSec连接功能的开启状态。
|
SslEnabled | Boolean | 否 | false | SSL连接功能的开启状态。
|
Status | String | 否 | Available | VPN网关的状态。
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 20220322145233010225243081016A**** | 请求ID。 |
PageSize | Integer | 20 | 当前分页的行数。 |
PageNumber | Integer | 1 | 当前页码。 |
TotalCount | Integer | 33 | 符合查询条件的VPN网关总数。 |
VpnGateways | Array of struct | - | VPN网关信息集合,具体请见下表“VpnGateway”。 |
VpnGateway
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountId | String | 20005**** | VPN网关所属账户的ID。 |
VpnGatewayId | String | vgw-3tehy13n2l4c6c0v**** | VPN网关的ID。 |
VpcId | String | vpc-1234567**** | VPN网关所在VPC的ID。 |
SubnetId | String | subnet-3thgqai7my4e8i4**** | VPN网关使用的端口所属子网的ID。 |
CreationTime | String | 2021-04-09T08:36:47+08:00 | 创建VPN网关的时间。 |
UpdateTime | String | 2021-04-10T08:36:47+08:00 | 更新VPN网关的时间。 |
VpnGatewayName | String | VpnGateway-test | VPN网关的名称。 |
IpAddress | String | 202.XX.XX.19 | VPN网关的IP地址。 |
Description | String | This is a sample description | VPN网关的描述。 |
Status | String | Available | VPN网关的状态。
|
Bandwidth | Integer | 20 | VPN网关的带宽规格。 |
ConnectionCount | Integer | 10 | VPN网关关联的IPsec连接的数量。 |
RouteCount | Integer | 20 | VPN网关上的路由条目数量。 |
BillingType | Integer | 1 | VPN网关的计费类型。
|
BusinessStatus | String | Normal | VPN网关的计费状态。
|
LockReason | String | unlock | VPN网关的锁定原因。
|
ExpiredTime | String | 2022-04-21 23:59:59 | VPN网关的到期时间。 |
DeletedTime | String | 2022-05-06 23:59:59 | VPN网关的到期删除时间。 |
Tags | Array of struct | - | VPN网关已添加的全部标签信息。具体请参见下表“Tag”。 |
ProjectName | String | Project_1 | VPN网关所属的项目。 |
IpsecEnabled | Boolean | true | IPSec连接功能是否开启。
|
SslEnabled | Boolean | false | SSL连接功能是否开启。
|
SslMaxConnections | Integer | 10 | SSL连接数规格。 |
OverdueTime | String | 2023-08-07T23:23:23+08:00 | 资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值,否则均返回空值。 |
IsBlocked | Boolean | false | 当前资源的状态是否被封禁。
|
Asn | Integer | 65534 | VPN网关的ASN。 |
Tag
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | key1 | 标签键。 |
Value | String | value1 | 标签值。 |
GET /?Action=DescribeVpnGateways&Version=2020-04-01&VpnGatewayIds.1=vgw-12bfa2du7fojk17q7y1rk****&PageNumber=1&PageSize=20 HTTP/1.1 Host: open.volcengineapi.com ServiceName: vpn Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "20220322145233010225243081016A****", "Action": "DescribeVpnGateways", "Version": "2020-04-01", "Service": "vpn", "Region": "cn-beijing" }, "Result": { "RequestId": "20220322145233010225243081016A****", "PageNumber": 1, "PageSize": 20, "TotalCount": 1, "VpnGateways": [ { "AccountId":"210000****", "VpnGatewayId":"vgw-12bfa2du7fojk17q7y1rk****", "CreationTime":"2022-03-21T11:14:30+08:00", "UpdateTime":"2022-03-21T11:15:19+08:00", "VpnGatewayName":"test", "Description":"test", "Status":"Available", "VpcId":"vpc-12bhs1ivo6p6o17q7y2x3****", "SubnetId":"subnet-2fewbgn7jbk0059gp67ap****", "IpAddress":"10.XX.XX.93", "RouteCount":0, "ConnectionCount":0, "Bandwidth":5, "BusinessStatus":"Normal", "LockReason":"unlock", "BillingType":1, "ExpiredTime":"2022-04-21 23:59:59", "DeletedTime":"2022-05-06 23:59:59", "ProjectName":"Project_1", "OverdueTime":"", "IpsecEnabled": true, "SslEnabled": false, "SslMaxConnections": 10, "IsBlocked": false, "Asn": 65534, "Tags":[ { "Key":"k1", "Value":"v1" }, { "Key":"k2", "Value":"" } ] } ] } }
此处仅展示当前API的错误码,更多错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
400 | LimitExceeded.VpnGatewayId | You've reached the limit on the number of VPN gateway IDs that you can describe. | 已达到可查询的VPN网关ID数量上限。 |
400 | InvalidTagFilterKey.Malformed | The specified parameter tag filter key is invalid. | 过滤标签键不合法。 |
400 | InvalidTagFilterValue.Malformed | The specified parameter tag filter value is invalid. | 过滤标签值不合法。 |
400 | LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 |
400 | LimitExceeded.TagFilterValue | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签值数量的上限。 |
400 | InvalidTagFilter.Disorder | The specified index order of tag filter is malformed. | 指定标签过滤项的索引顺序参数格式不合法。 |