菜单

查询客户端列表

下载

接口地址:/webapi/client/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取Client列表分页和高级检索

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
clientId	客户端id	query	false	string
clientIdList	客户端ID集合	query	false	string
clientName	服务器名称	query	false	string
clientIp	服务器地址	query	false	string
osVersion	操作系统	query	false	string
clientType	客户端代理类型	query	false	string
updateStatus	更新状态	query	false	string
status	状态	query	false	string
requestId	请求ID	query	false	string
page	当前页。默认1	query	false	string
pageSize	页数。默认-1	query	false	string
userGroupId	用户组ID	query	false	string
authType	授权类型	query	false	string
ignoreDataAuth	忽略数据权限	query	false	string

响应状态:

状态码	说明	schema
200	OK	ResponseResultPageClientListVo

响应参数:

参数名称	参数说明	类型	schema
message	返回状态标记	string
statFlag	返回状态	integer(int32)	integer(int32)
dataInfo		PageClientListVo	PageClientListVo
records		array	ClientListVo
clientName	客户端名称	string
releaseName	客户端版本	string
flags		integer(int32)
description	描述	string
installFolder	安装文件夹	string
lastBackupJobId	上一次备份作业Id	integer(int32)
clientType	客户端类型	array	integer
osVersion	操作系统版本	string
releaseId	客户端版本Id	string
agentList	客户端列表	string
enableRecover	启动恢复	integer(int32)
clientId	客户端Id	integer(int32)
registerTime	注册时间	integer(int64)
nodeJson	节点信息	string
archName		string
osId	操作系统Id	integer(int32)
backupSize	备份大小	integer(int64)
updateStatus	更新状态	integer(int32)
clientIp	客户端IP	string
csdPort	客户端端口	integer(int32)
clientCacheFolder	客户端缓存文件夹	string
guid	客户端guid	string
endTime	结束时间	integer(int64)
enableBackup	启动备份	integer(int32)
status	客户端状态	integer(int32)
maxConcurrentStream	最大并发流数	string
agentName	客户端类型名称	string
indexCache	存储节点缓存目录	string
platformId	系统版本Id	integer(int32)
relId	客户端releaseId	integer(int32)
accessNodes	访问节点	string
dbIp	访问节点的dbIp	string
agentInfo	访问节点的agentInfo	string
mgnodeInfo	访问节点的mgnodeInfo	string
logPath	日志收集上传路径	string
total		integer(int64)
size		integer(int64)
current		integer(int64)
orders		array	OrderItem
column		string
asc		boolean
optimizeCountSql		PageClientListVo	PageClientListVo
searchCount		PageClientListVo	PageClientListVo
optimizeJoinOfCountSql		boolean
maxLimit		integer(int64)
countId		string
pages		integer(int64)
dataCount	返回数据条数	integer(int32)	integer(int32)

响应示例:

javascript 复制代码

{
	"message": "操作成功",
	"statFlag": 0,
	"dataInfo": {
		"records": [
			{
				"clientName": "",
				"releaseName": "",
				"flags": 0,
				"description": "",
				"installFolder": "",
				"lastBackupJobId": 0,
				"clientType": [],
				"osVersion": "",
				"releaseId": "",
				"agentList": "",
				"enableRecover": 0,
				"clientId": 0,
				"registerTime": 0,
				"nodeJson": "",
				"archName": "",
				"osId": 0,
				"backupSize": 0,
				"updateStatus": 0,
				"clientIp": "",
				"csdPort": 0,
				"clientCacheFolder": "",
				"guid": "",
				"endTime": 0,
				"enableBackup": 0,
				"status": 0,
				"maxConcurrentStream": "",
				"agentName": "",
				"indexCache": "",
				"platformId": 0,
				"relId": 0,
				"accessNodes": "",
				"dbIp": "",
				"agentInfo": "",
				"mgnodeInfo": "",
				"logPath": ""
			}
		],
		"total": 0,
		"size": 0,
		"current": 0,
		"orders": [
			{
				"column": "",
				"asc": true
			}
		],
		"optimizeCountSql": {},
		"searchCount": {},
		"optimizeJoinOfCountSql": true,
		"maxLimit": 0,
		"countId": "",
		"pages": 0
	},
	"dataCount": 10
}

上一个

客户端管理

下一个

查看客户端属性

最近修改: 2024-12-13