接口功能介绍
展示某个网关当前的详情信息
接口约束
1、用户需要已创建有至少一个网关才能返回详情信息
URI
GET /v4/nfs/get-gateway-detail
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| gatewayID | 是 | String | 网关的ID | 参考请求示例 | |
| regionID | 是 | String | 资源池ID | 参考请求示例 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为处理中/失败) | 800 | |
| returnObj | Object | 响应对象 | 参考表 returnObj | |
| message | String | 状态描述 | SUCCESS | |
| description | String | 状态描述，一般为中文 | 成功 | |
| error | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码大驼峰形式 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Object | 响应对象 | 参考表result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| gatewayStatus | String | 网关的状态，①deploying：部署中；②running：运行中；③deleting：删除中；④frozen：已过期（包周期计费的网关已过期，按需计费的网关为已冻结，目前仅支持包周期计费的网关） | 参考响应示例 | |
| cacheDiskTotal | Integer | 网关下已挂载的缓存盘数量，单位个 | 参考响应示例 | |
| gatewayID | String | 网关的ID | 参考响应示例 | |
| gatewayName | String | 网关的名称 | 参考响应示例 | |
| endpointServiceID | String | 若选用终端节点服务方案，则展示为终端节点服务ID；若选用弹性公网方案，则展示为空 | 参考响应示例 | |
| bandwidth | String | 若选用弹性公网方案，则为网关开通的公网带宽；若选用终端节点服务方案，则展示为0 | 参考响应示例 | |
| gatewayIP | String | 网关的IP地址；仅在存在公网IP时展示，否则为空 | 参考响应示例 | |
| createTime | String | 网关的创建时间 | 参考响应示例 | |
| expiredTime | String | 网关的到期时间（包周期计费下展示到期时间，按需计费展示无，目前仅支持包周期计费的网关） | 参考响应示例 | |
| regionID | String | 资源池ID | 参考响应示例 | |
| gatewayType | String | 网关的类型，①file_gw：文件网关 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayID":"a6c48f28-111c-11ef-b7e0-18022d1723b2"
}
响应示例
{
"returnObj":{
"result":{
"cacheDiskTotal":1,
"gatewayName":"zhouyizunduhaokun",
"gatewayIP":"192.168.0.30",
"gatewayType":"file_gw",
"bandwidth":"0",
"gatewayID":"a6c48f28-111c-11ef-b7e0-18022d1723b2",
"createTime":"2024-05-13T11:33:42Z",
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayStatus":"running",
"expiredTime":"2024-06-13T11:31:34Z",
"endpointServiceID":"endpser-zbe0y5zt0u"
}
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
