接口功能介绍
展示该用户账户下已开通的网关资源
接口约束
1、用户需要已创建至少一个网关资源
2、查询网关列表会提供网关的部分详情信息
URI
GET /v4/nfs/get-gateway-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 参考请求示例 | |
| searchName | 否 | String | 模糊搜索网关名称 | 参考请求示例 | |
| gatewayStatus | 否 | String | 筛选网关状态，①deploying：部署中；②running：运行中；③deleting：删除中；④frozen：已过期（包周期计费的网关已过期，按需计费的网关为已冻结，目前仅支持包周期计费的网关） | 参考请求示例 | |
| projectID | 否 | String | 筛选企业项目，由于目前创建网关资源均为默认企业项目ID，暂不支持筛选 | 参考请求示例 | |
| pageNo | 否 | Integer | 页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 页大小，默认值 10，取值范围 1~50 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| returnObj | Object | 响应对象 | 参考表 returnObj | |
| message | String | 状态描述 | SUCCESS | |
| description | String | 状态描述，一般为中文 | 成功 | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 响应对象 | 参考表results | |
| totalCount | Integer | 总数量 | 5 | |
| pageNo | Integer | 当前页 | 1 | |
| pageSize | Integer | 当前页展示数量 | 10 | |
| currentCount | Integer | 当前页记录数 | 10 |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| gatewayStatus | String | 单个网关的状态，①deploying：部署中；②running：运行中；③deleting：删除中；④frozen：已过期（包周期计费的网关已过期，按需计费的网关为已冻结，目前仅支持包周期计费的网关） | 参考响应示例 | |
| gatewayID | String | 单个网关的ID | 参考响应示例 | |
| gatewayName | String | 单个网关的名称 | 参考响应示例 | |
| projectID | String | 单个网关所属的企业项目 | 参考响应示例 | |
| gatewayIP | String | 单个网关的IP地址；仅在存在公网IP时展示，否则为空 | 参考响应示例 | |
| gatewayPosition | String | 单个网关的位置，①ctyun：天翼云位置（目前仅支持“天翼云”位置） | 参考响应示例 | |
| gatewaySpec | String | 单个网关的规格，①standard：标准版网关（目前仅支持标准版网关） | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| gatewayType | String | 单个网关的类型，①file_gw：文件网关（目前仅支持文件网关类型） | 参考响应示例 | |
| endpointServiceID | String | 若选用终端节点服务方案，则展示为终端节点服务ID；若选用弹性公网方案，则展示为空 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"pageNo":2,
"pageSize":5,
"gatewayStatus":"running"
}
响应示例
{
"returnObj":{
"currentCount":5,
"totalCount":26,
"pageSize":5,
"results":[
{
"gatewayType":"file_gw",
"gatewayName":"TEST122YYY",
"endpointServiceID":"",
"gatewayIP":"192.168.0.58",
"gatewayID":"dcf6debe-b8cc-11ee-ac93-18022d1723b2",
"projectID":"0",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayPosition":"ctyun",
"gatewayStatus":"running",
"gatewaySpec":"standard"
},
{
"gatewayType":"file_gw",
"gatewayName":"zaihuanyigemingzi",
"endpointServiceID":"",
"gatewayIP":"192.168.0.109",
"gatewayID":"a0991464-c00b-11ee-ae9f-18022d1723b2",
"projectID":"0",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayPosition":"ctyun",
"gatewayStatus":"running",
"gatewaySpec":"standard"
},
{
"gatewayType":"file_gw",
"gatewayName":"xinqingfuza",
"endpointServiceID":"",
"gatewayIP":"192.168.0.115",
"gatewayID":"8a26498c-c0c8-11ee-ae9f-18022d1723b2",
"projectID":"0",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayPosition":"ctyun",
"gatewayStatus":"running",
"gatewaySpec":"standard"
},
{
"gatewayType":"file_gw",
"gatewayName":"mingtianjiuyaohuijiale",
"endpointServiceID":"",
"gatewayIP":"192.168.0.127",
"gatewayID":"67c047aa-c4d1-11ee-ae9f-18022d1723b2",
"projectID":"0",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayPosition":"ctyun",
"gatewayStatus":"running",
"gatewaySpec":"standard"
},
{
"gatewayType":"file_gw",
"gatewayName":"890",
"endpointServiceID":"",
"gatewayIP":"192.168.0.132",
"gatewayID":"7c83f678-cfc6-11ee-ae9f-18022d1723b2",
"projectID":"0",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayPosition":"ctyun",
"gatewayStatus":"running",
"gatewaySpec":"standard"
}
],
"pageNo":2
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
