白皮书下载
高密度机器人
一、服务器新增
接口说明
该接口是为了提供高密度机器人功能服务器新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-server/add
HTTP method: POST
Content-Type: application/json
请求样例
{
"name": "openapi测试服务器003", // 服务器名称
"serverAddr": "127.0.0.5", // 服务器地址
"port": 5555 // 服务器端口
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
name |
String |
是 |
服务器名称(最长50个字符) |
|
serverAddr |
String |
是 |
服务器地址(最长30个字符) |
|
port |
Integer |
是 |
服务器端口 |
响应样例
{
"msg": "success",
"code": 0,
"data": "1412292422171398145" //服务器id
}
二、服务器更新
接口说明
该接口是为了提供高密度机器人功能服务器更新所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-server/update
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412292422171398145, //服务器id，服务器新增时返回的参数
"name": "openapi测试服务器003修改", // 服务器名称
"serverAddr": "127.0.0.9", // 服务器地址
"port": 3391 // 服务器端口
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器id，服务器新增时返回的参数 |
|
name |
String |
是 |
服务器名称(最长50个字符) |
|
serverAddr |
String |
是 |
服务器地址(最长30个字符) |
|
port |
Integer |
是 |
服务器端口 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
三、服务器删除
接口说明
该接口是为了提供高密度机器人功能服务器删除所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-server/delete
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412292422171398145, //服务器id，服务器新增时返回的参数
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器id，服务器新增时返回的参数 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
四、根据id查询服务器详情
接口说明
该接口是为了提供高密度机器人功能服务器id查询所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-server/select-win-server-by-id
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412292422171398145, //服务器id，服务器新增时返回的参数
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器id，服务器新增时返回的参数 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"winServerID": "1412292422171398145", // 服务器id
"winServerName": "openapi测试服务器003修改", // 服务器名称
"serverAddr": "127.0.0.9", // 服务器地址
"port": 3391, // 服务器端口
"gmtCreated": "2021-07-06 14:08:47", // 创建时间
"gmtModified": "2021-07-06 14:18:44" // 修改时间
}
}
五、根据服务器名称右模糊查询服务器列表
接口说明
该接口是为了提供高密度机器人功能服务器列表查询所使用的接口，通过创建时间降序排序。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-server/select-win-server-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"winServerName": "open"
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
winServerName |
String |
否 |
服务器名称 |
响应样例
{
"msg": "success",
"code": 0,
"data": [
{
"winServerID": "1412292422171398145", // 服务器id
"winServerName": "openapi测试服务器003修改", // 服务器名称
"serverAddr": "127.0.0.9", // 服务器地址
"port": 3391, // 服务器端口
"gmtCreated": "2021-07-06 14:08:47", // 创建时间
"gmtModified": "2021-07-06 14:18:44" // 修改时间
},
{
"winServerID": "1411867369248206850",
"winServerName": "openapi测试服务器002",
"serverAddr": "127.0.0.4",
"port": 3309,
"gmtCreated": "2021-07-05 09:59:47",
"gmtModified": "2021-07-05 09:59:53"
},
{
"winServerID": "1411866976552300545",
"winServerName": "openapi测试服务器001修改",
"serverAddr": "127.0.0.3",
"port": 3399,
"gmtCreated": "2021-07-05 09:58:13",
"gmtModified": "2021-07-05 09:59:22"
}
]
}
六、服务器用户新增
接口说明
该接口是为了提供高密度机器人功能服务器用户新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/add
HTTP method: POST
Content-Type: application/json
请求样例
{
"name": "openAPi测试用户003", // 服务器用户名称
"password": "123456", // 服务器用户密码
"automatLogin": 0, // 是否自动登录，1-是，0-否
"winServerId": 1412292422171398145 // 服务器id，服务器新增返回参数
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
name |
String |
是 |
服务器名称（最大30位） |
|
password |
String |
是 |
服务器用户密码（最大30位） |
|
automatLogin |
Integer |
是 |
是否自动登录，1-是，0-否 |
|
winServerId |
Long |
是 |
服务器id，服务器新增返回参数 |
响应样例
{
"msg": "success",
"code": 0,
"data": "1412299796881879041" // 服务器用户id
}
七、服务器用户更新
接口说明
该接口是为了提供高密度机器人功能服务器用户更新所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/update
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412299796881879041, // 服务器用户id，服务器用户新增返回
"name": "openAPi测试用户003修改", // 服务器用户名
"password": "12345611", // 服务器用户密码
"automatLogin": 0 // 是否自动登录，1-是，0-否
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器用户id，服务器新增返回 |
|
name |
String |
是 |
服务器名称（最大30位） |
|
password |
String |
是 |
服务器用户密码（最大30位） |
|
automatLogin |
Integer |
是 |
是否自动登录，1-是，0-否 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
八、服务器用户删除
接口说明
该接口是为了提供高密度机器人功能服务器用户删除所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/delete
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412299796881879041, // 服务器用户id，服务器用户新增返回
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器用户id，服务器新增返回 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
九、根据id查询服务器用户详情
接口说明
该接口是为了提供高密度机器人功能服务器用户根据id查询所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/select-win-user-by-id
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412299796881879041, // 服务器用户id，服务器用户新增返回
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器用户id，服务器新增返回 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"winUserID": "1412299796881879041", // 服务器用户id
"winUserName": "openAPi测试用户003修改", // 服务器用户名称
"automatLogin": 0, // 是否自动登录，1-是，0否
"connState": null, //连接状态：0-未连接、1-已连接，2-连接异常，3-连接中
"errorMsg": null, // 异常原因
"connTime": "30", // 连接时常，单位：秒
"winServerID": "1412292422171398145", // 服务器id
"gmtCreated": "2021-07-06 14:38:05", // 创建时间
"gmtModified": "2021-07-06 14:51:27" // 修改时间
}
}
十、查询服务器用户列表
接口说明
该接口是为了提供高密度机器人功能服务器用户查询列表所使用的接口，通过创建时间降序排序。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/select-win-user-list
HTTP method: POST
Content-Type: application/json
请求样例
{
"winServerID": 1412292422171398145, // 服务器id
"winUserName": "openAPi", // 服务器用户名（右模糊查询）
"automatLogin":0, // 是否自动登录，1-是，0-否
"connState": 0 // 0-未连接、1-已连接，2-连接异常，3-连接中
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
winServerID |
Long |
否 |
服务器id |
|
winUserName |
String |
否 |
服务器名称(右模糊查询) |
|
automatLogin |
Integer |
否 |
是否自动登录，1-是，0-否 |
|
connState |
Integer |
否 |
连接状态：0-未连接、1-已连接，2-连接异常，3-连接中 |
响应样例
{
"msg": "success",
"code": 0,
"data": [
{
"winUserID": "1412299796881879041", // 服务器用户id
"winUserName": "openAPi测试用户003修改", // 服务器用户名称
"automatLogin": 0, // 是否自动登录，1-是，0-否
"connState": 0, //连接状态0-未连接、1-已连接，2-连接异常，3-连接中
"errorMsg": null, // 异常原因
"connTime": "30", // 连接时常，单位：秒
"winServerID": "1412292422171398145", // 服务器id
"gmtCreated": "2021-07-06 14:38:05", // 创建时间
"gmtModified": "2021-07-06 14:51:27" // 修改时间
},
{
"winUserID": "1411871058184695809",
"winUserName": "openAPi测试用户002",
"automatLogin": 0,
"connState": 0,
"errorMsg": null,
"connTime": "81957",
"winServerID": "1411867369248206850",
"gmtCreated": "2021-07-05 10:14:26",
"gmtModified": "2021-07-05 16:23:19"
}
]
}
十一、服务器用户连接
接口说明
该接口是为了提供高密度机器人功能，服务器用户连接服务器所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/conn
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412299796881879041, // 服务器用户id，服务器用户新增返回
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器用户id，服务器新增返回 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
十二、服务器用户断开
接口说明
该接口是为了提供高密度机器人功能，服务器用户断开服务器所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/win-user/dis-conn
HTTP method: POST
Content-Type: application/json
请求样例
{
"id": 1412299796881879041, // 服务器用户id，服务器用户新增返回
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
id |
Long |
是 |
服务器用户id，服务器新增返回 |
响应样例
{
"msg": "success",
"code": 0,
"data": true // true-成功，false-失败
}
