You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

DescribeCustomerGateways

最近更新时间：2024.04.18 17:23:56

首次发布时间：2022.04.28 07:17:15

我的收藏

调用DescribeCustomerGateways按指定条件查询用户网关。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeCustomerGateways要执行的操作，取值：DescribeCustomerGateways。
VersionString是2020-04-01API版本信息。
PageSizeInteger否20分页查询时每页的行数。最大值为100，默认值为20。

PageNumber

Integer

否

1

分页查询的页码。

  • 如需传入此参数，请传入非负整数。
  • 不传或传入0，则均默认为1。

CustomerGatewayIds.N

List of String

否

CustomerGatewayIds.1=cgw-3tehy13n2l4c6c0v****&CustomerGatewayIds.2=cgw-fsngkej34mf****

用户网关的ID。

  • 参数 - N：表示用户网关ID的序号。
  • 多个ID之间用&分隔。
CustomerGatewayNameString否CGW-te001用户网关的名称。
IpAddressString否8.XX.XX.8用户网关的出口IP地址。

ProjectName

String

否

Project_1

用户网关所属的项目。

  • 传入该字段，表示查询指定项目下的用户网关。

  • 不传入该字段，表示查询所有项目的用户网关。

返回数据

名称类型
示例值
描述
RequestIdString202203211611080102121461940900****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger33符合条件的用户网关的总数。
CustomerGatewaysArray of struct-用户网关的详细信息。具体请参见下表“CustomerGateway”。

CustomerGateway

名称类型
示例值
描述
AccountIdString20005****用户网关所属账户的ID。
CustomerGatewayIdStringcgw-3tehy13n2l4c6c0v****用户网关的ID。
IpAddressString8.XX.XX.8用户网关的出口IP地址。
ConnectionCountInteger8用户网关关联的IPsec连接的数量。
CreationTimeString2021-04-09T08:36:47+08:00创建用户网关的时间。
UpdateTimeString2021-04-09T10:30:00+08:00更新用户网关的时间。
CustomerGatewayNameStringCGW-q04n用户网关的名称。
DescriptionStringThis is a sample description用户网关的描述信息。

Status

String

Available

用户网关的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending：配置中
  • Available：可用
ProjectNameStringProject_1用户网关所属的项目。

请求示例

GET /?Action=DescribeCustomerGateways&Version=2020-04-01&CustomerGatewayIds.1=cgw-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203211611080102121461940900****",
        "Action": "DescribeCustomerGateways",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202203211611080102121461940900****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "CustomerGateways": [
            {
                "AccountId":"210000****",
                "CustomerGatewayId": "cgw-7qthudw0ll6jmc****",
                "CustomerGatewayName": "test",
                "Description": "test",
                "IPAddress":"1.XX.XX.1",
                "ConnectionCount":8,
                "CreationTime": "2022-03-16T17:05:42+08:00",
                "UpdateTime": "2022-03-17T11:50:30+08:00",
                "ProjectName":"Project_1",
                "Status": "Available"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.CustomerGatewayIdYou've reached the limit on the number of customer gateway IDs that you can describe.已达到可查询的用户网关ID数量上限。