有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能描述

用于获取网关列表。

请求

请求url

GET /ivc/cms/gateway/list

请求参数

path
ClusterId=xxx&Name=xxx&Status=xxx&PageNumber=1&PageSize=20
字段名
类型
描述
必须
备注
PageNumber
int
页码,默认为1
默认为1
PageSize
int
每页数量,默认为20
默认为20
Name
string
网关名称
-
ClusterId
string
服务节点Id
-
Status
int
网关状态
0:离线,1:在线

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求操作无请求体。

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/json 数据,包含完整节点数据的内容展示如下:
{
"RequestId": "",
"Code": 0,
"StatusCode": 200,
"Message": "ok",
"Data": {
"List":[
{
"Id": "f4516bd0-38c6-4007-baf9-0a73d27ccba8",
"GwId": "h3HRECtISGGnsPjxoYW1mEc2NjMhd1Ur",
"Name": "A店铺",
"Description": "A店铺网关",
"ClusterId": "e4516bd0-38c6-4007-baf9-0a73d27ccba8",
"ClusterName":"上海1",
"Status": 1,
"CreatedAt":"2022-09-22T09:22:23"
}
],
"TotalCount": 12581
}
}
字段名
类型
描述
备注
RequestId
string
请求id
-
Code
int
状态码,0 成功,500 操作失败
-
StatusCode
int
错误码,200 OK,其他详见错误中心
-
Message
string
返回消息
-
Data
object
返回结果
-
+Data
字段名
类型
描述
备注
List
Object Array
网关列表
-
TotalCount
string
网关总数
-
+List
字段名
类型
描述
备注
Id
string
网关索引id
-
GwId
string
网关编码
-
Name
string
网关名称
仅支持中文、英文、数字、_、-,长度不超过32个字符
Description
string
网关描述
仅支持中文、英文、数字、_、-,长度不超过128个字符
ClusterId
string
服务节点id
-
ClusterName
string
服务节点名称
-
Status
int
网关状态
0:离线,1:在线
CreatedAt
string
网关激活时间