接口功能介绍
查询已创建的VPN用户网关
接口约束
支持主备模式资源池。
URI
GET /v4/vpn/user-gateway/list
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | ||
| pageNo | 否 | String | 页码 | 1 | |
| pageSize | 否 | String | 页大小 | 10 | |
| userGatewayID | 否 | String | 用户网关ID | ||
| userGatewayName | 否 | String | 用户网关名称 | ||
| queryContent | 否 | String | 模糊查询 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| errorDetail | String | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前返回的用户网关数量 | ||
| totalCount | Integer | 总共的用户网关数量 | ||
| totalPage | Integer | 总共页数 | ||
| results | Array of Object | 用户网关列表 | UserGateway | |
| errorCode | String | 错误码 | ||
| message | String | 错误信息 | ||
| description | String | 描述 | ||
| statusCode | String | 800成功，900失败 |
表UserGateway
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpnConnectionID | String | VPN连接ID | ||
| userGatewayName | String | 用户网关名字 | ||
| userGatewayID | String | 用户网关ID | ||
| resourceId | String | 用户网关资源ID | ||
| azName | String | 可能区名字 | ||
| dataID | String | 数据ID | ||
| isMaz | Boolean | 是否多可用区 | ||
| isPaas | Boolean | 是否为Paas | ||
| azID | String | 可用区ID | ||
| regionId | String | 资源池ID | ||
| availabilityZone | String | 可用区 | ||
| isTalkOrder | Boolean | 是否按需单 | ||
| azDisplayName | String | 可用区展示名字 | ||
| paymentType | String | 本参数表示付款类型。 取值范围： MONTH YEAR onDemand |
||
| projectIDEcs | String | Project ID | ||
| customerId | String | 客户ID | ||
| createdTime | String | 创建时间 | ||
| expiredTime | String | 过期时间 | ||
| updatedTime | String | 更新时间 | ||
| deletedTime | String | 删除时间 | ||
| ipAddress | String | IP地址 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"userGatewayID": "ff809aec-8f4b-4d46-8f18-b8fef3fb8325",
"userGatewayName": "user-gateway-4ca9-mlkjk",
"pageNo": "1",
"pageSize": "1"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 9,
"totalPage": 9,
"results": [{
"vpnConnectionID": "aaa9ae52-3fcc-11ed-ba27-005056897257",
"dataID": null,
"availabilityZone": null,
"azID": null,
"resourceId": null,
"regionId": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"paymentType": null,
"azName": null,
"tenantId": null,
"userGatewayID": "500fd9e3-dddf-479a-97bd-4a9b245f3204",
"isMaz": false,
"updatedTime": "2022-09-29T07:58:40Z",
"userGatewayName": "user-gateway-tong2",
"isTalkOrder": false,
"isPaas": false,
"deletedTime": null,
"customerId": "e19a4b13-ce65-53ff-97f1-8fc09f6f28e7",
"expiredTime": null,
"createdTime": "2022-09-29T07:56:22Z",
"projectIDEcs": "0",
"ipAddress": "100.124.2.18",
"azDisplayName": ""
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.VPN.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
