接口功能介绍
查询SSL服务端
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/ssl-server/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
get请求包含body参数,报文头指定application/json,且body结构对象需要转json。
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| queryContent | 否 | String | Query Content模糊查询 | ssl-client-1 | |
| projectID | 否 | String | project id | 0 | |
| pageSize | 否 | Integer | 每页行数 | 1 | |
| pageNo | 否 | Integer | 页码 | 1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800：成功 900：失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 链路追踪ID | 616797965481 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| currentCount | 否 | Integer | 当前页记录数 | 2 | |
| totalPage | 否 | Integer | 总页数 | 2 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnServiceID | 否 | String | VPN实例ID | e867f3d3-a64f-5cf1-b0a9-35c236cdb4a2 | |
| vpnServiceName | 否 | String | VPN实例名称 | vpnservice1 | |
| localSubnets | 否 | String | 本端子网，如有多个子网由逗号分隔 | 192.168.0.0/24 | |
| ipPoolSubnet | 否 | String | 客户端地址池 | 192.168.3.0 | |
| ipPoolMask | 否 | String | 客户端地址池掩码长度 | "24" | |
| sslServerName | 否 | String | SSL服务端名称 | ssl-server-f6ee | |
| vpcTenantID | 否 | String | vpc tenant ID | 05fb4965e6a264a8ab48287500c26f68 | |
| vpcName | 否 | String | vpc name | vpc-367 | |
| vpcID | 否 | String | vpc ID | vpc-65g6iquc1k | |
| status | 否 | String | 连接状态 | normal | |
| sslConnectLimit | 否 | String | ssl connect limit | 10 | |
| ecID | 否 | String | express-connect ID | e867f3d3-a64f-5cf1-b0a9-35c236cdb4a2 | |
| sslProtocal | 否 | String | SSL协议 | tcp | |
| sslPort | 否 | String | 端口号 | 1909 | |
| enableDNS | 否 | Boolean | 是否开启DNS 取值范围: false:不开启 true:开启 |
false | |
| dns | 否 | String | DNS地址 | 114.114.114.114 | |
| twoFactorVerify | 否 | Boolean | 是否开启双因子认证 取值范围: false:不开启 true:开启 |
false | |
| sslServerID | 否 | String | vpn服务端uuid | 04697f7d-2d5f-4b98-af10-d89c514626c7 | |
| createTime | 否 | String | create time | 2023-07-12 16:49:44 |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002"
}
响应示例
{
"returnObj":{
"totalCount":1,
"currentCount":1,
"totalPage":1,
"results":[
{
"status":"normal",
"sslConnectLimit":"10",
"vpcID":"vpc-65g6iquc1k",
"dns":null,
"ecID":"",
"sslServerID":"7958302a-c3b8-4ab6-8e7e-de4fea8c8b82",
"sslServerName":"ssl-server-f6ee",
"createTime":"2023-06-13 12:49:32",
"vpcTenantID":"05fb4965e6a264a8ab48287500c26f68",
"twoFactorVerify":false,
"vpcName":"vpc-367b",
"ipPoolSubnet":false,
"sslProtocal":"tcp",
"ipPoolMask":"24",
"sslPort":"1194",
"localSubnets":"10.111.0.0/24",
"vpnServiceName":"vpc-367b-ssl"
}
],
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
