1. 接口描述
本接口（DescribeUserGw）用于查询对端网关。
接口请求域名：vpc.api.qcloud.com
2. 输入参数
参数名称 | 是否必选 | 类型 | 描述 |
userGwId | 否 | String | 对端网关 ID 或者统一 ID，建议使用统一 ID，例如 cgw-1tb1k34n。 |
userGwName | 否 | String | 对端网关名称。 |
offset | 否 | Int | 初始行的偏移量，默认为0。 |
limit | 否 | Int | 每页行数，默认为20，最大支持50。 |
orderField | 否 | String | 按某个字段排序，目前支持 userGwName 和默认按 createTime 排序，默认按 createTime 排序。 |
orderDirection | 否 | String | 升序（asc）还是降序（desc）,默认：desc。 |
3. 输出参数
参数名称 | 类型 | 描述 |
code | Int | |
message | String | 模块错误信息描述，与接口相关。 |
totalCount | Int | 返回结果中对端网关总数量。 |
data.n | Array | 返回的数组。 |
data.userGwName | String | 对端网关名称。 |
data.userGwId | Int | 系统分配的对端网关 ID，例如400。 |
data.unUserGwId | String | 系统分配的新的对端网关 ID，推荐使用新的对端网关 ID，例如 cgw-1tb1k34n。 |
data.userGwAddr | String | 对端网关公网 IP。 |
data.vpnConnNum | Int | 已链接的通道数量。 |
data.createTime | String | 创建时间：2016-06-23 11:11:49。 |
4. 错误码表
错误码 | 描述 |
InvalidUserGw.NotFound |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeUserGw&<公共请求参数>
输出
{"code":"0","message":"","totalCount":"20","data":[{"userGwName":"183.60.249.12","userGwId":"404","unUserGwId":"cgw-1tb1k34n","userGwAddr":"183.60.249.12","vpnConnNum":"1","createTime":"2016-06-23 11:11:49"},{"userGwName":"183.60.249.138","userGwId":"403","unUserGwId":"cgw-mzmzjzf9","userGwAddr":"183.60.249.138","vpnConnNum":"1","createTime":"2016-06-22 21:20:54"},{"userGwName":"SH","userGwId":"402","unUserGwId":"cgw-2530cjg1","userGwAddr":"222.92.194.28","vpnConnNum":"1","createTime":"2016-04-28 14:15:41"},{"userGwName":"183.60.249.126","userGwId":"401","unUserGwId":"cgw-j8pcwzu9","userGwAddr":"183.60.249.126","vpnConnNum":"1","createTime":"2016-04-22 12:18:05"},{"userGwName":"183.60.249.129","userGwId":"400","unUserGwId":"cgw-blr1nrwb","userGwAddr":"183.60.249.129","vpnConnNum":"1","createTime":"2016-04-21 20:47:47"},{"userGwName":"183.60.249.121","userGwId":"399","unUserGwId":"cgw-ov9j6csd","userGwAddr":"183.60.249.121","vpnConnNum":"0","createTime":"2016-04-21 20:47:14"},{"userGwName":"183.60.249.95","userGwId":"397","unUserGwId":"cgw-g013kis9","userGwAddr":"183.60.249.95","vpnConnNum":"0","createTime":"2016-01-23 13:41:35"},{"userGwName":"183.60.249.33","userGwId":"396","unUserGwId":"cgw-c5p3f6fr","userGwAddr":"183.60.249.33","vpnConnNum":"0","createTime":"2016-01-18 17:08:09"},{"userGwName":"115.159.143.150","userGwId":"344","unUserGwId":"cgw-oe7vq0uz","userGwAddr":"115.159.143.150","vpnConnNum":"0","createTime":"2015-11-26 02:30:02"},{"userGwName":"9101","userGwId":"315","unUserGwId":"cgw-e098slul","userGwAddr":"183.60.249.39","vpnConnNum":"0","createTime":"2015-11-06 11:18:53"}],"codeDesc":"Success"}
