全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
专有网络 VPC

查询用户网关列表

更新时间:2017-10-10 21:46:27

描述

本接口用于查询用户网关列表。支持分页查询,每页默认10条。

请求参数

参数名 类型 是否必须 描述
Action String 系统规定参数,取值:DescribeCustomerGateways
RegionId String 指定查询CustomerGateways列表的地域
CustomerGatewayId String 过滤类参数。如指定该参数,只返回指定CustomerGatewayId的结果,不指定该参数则为不过滤。
PageNumber Integer 实例状态列表的页码,起始值为 1,默认值为 1
PageSize Integer 分页查询时设置的每页行数,最大值 50 行,默认为 10

返回参数

参数名 类型 描述
CustomerGateways List CustomerGateway列表
TotalCount Integer 列表条条目数
PageNumber Integer 当前页码
PageSize Integer 当前分页包含多少条目

CustomerGateway 列表

名称 类型 描述
CustomerGatewayId String CustomerGateway唯一标识
Name String CustomerGateway名称
Description String CustomerGateway描述信息
IpAddress String CustomerGateway IP地址
CreateTime Long CustomerGateway 创建时间

错误码

ErrCode Message Http Status 描述
InvalidCustomerGatewayId.NotFound Specified CustomerGateway is not found 404 指定的用户网关不存在
InvalidPageSize The specified value of PageSize not supported 400 PageSize 非法
InvalidPageNumber The specified value of PageNumber not supported 400 PageNumber 非法

示例

请求示例

  1. https://vpc.aliyuncs.com/?Action=DescribeCustomerGateways
  2. &RegionID=cn-beijing
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeCustomerGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>3</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
  6. <CustomerGateways>
  7. <CustomerGateway>
  8. <Name>test</Name>
  9. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  10. <CreateTime>1492747187000</CreateTime>
  11. <IpAddress>139.196.32.167</IpAddress>
  12. </CustomerGateway>
  13. </CustomerGateways>
  14. </DescribeCustomerGatewaysResponse>

JSON格式

  1. {
  2. "PageNumber":1,
  3. "TotalCount":3,
  4. "PageSize":10,
  5. "RequestId":"E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  6. "CustomerGateways":{
  7. "CustomerGateway":[
  8. {
  9. "Name":"test",
  10. "CustomerGatewayId":"cgw-bp1pvpl9r9adju6l5nxck",
  11. "CreateTime":1492747187000,
  12. "IpAddress":"139.196.32.167"
  13. }
  14. ]
  15. }
  16. }
本文导读目录