ZukVnc (1.2)

Download OpenAPI specification:Download

ZukRec的RESTFul接口文档

task

进行中任务相关接口

创建新任务

Request Body schema: application/json

url required	string 页面链接，任务对应的页面url
callback	string 回调地址
region	string 任务运行的区域，当前仅支持us-east-1和cn-north-1
width	number 宽
height	number 高
spot	boolean 是否使用spot实例

Responses

202

服务器已收到创建请求

401

用户未登录

post /tasks

https://rec.zukdoor.cloud/api/v1/tasks

Request samples

Payload
Java

Content type

application/json

Copy

Expand all Collapse all


{"url": "https://www.zhihu.com/",
"callback": "http://18.234.175.38:10003/api/v1/test/callback",
"region": "cn-north-1"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"display": 0,
"userId": "string",
"url": "string",
"callback": "string",
"createdTime": 0
}

列出所有任务

query Parameters

pageSize	number 每一页展示的任务数量，默认为20
pageNum	number 页数，从0开始，默认为0
userId	string
stopped	boolean
startedTime	number
stoppedTime	number

Responses

200

操作成功

401

用户未登录

403

用户无权限

get /tasks

https://rec.zukdoor.cloud/api/v1/tasks

Request samples

Java

Copy

ZukVncClient client = ZukVncClient.create("your_username", "your_password");
QueryTasksResponse response = client.queryTasks(new QueryTasksRequest(30, 1, null, true));
System.out.println("Total tasks: " + response);

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": 0,
"userId": "string",
"startTime": 0,
"stopTime": 0,
"recordingName": "string",
"rtmpUrls": 
["string"
],
"recordFiles": 
[
{"taskId": 0,
"recordName": "string",
"createdTime": "string",
"size": 0
}
],
"ended": true
}
],
"totalCount": 0
}

修改任务参数

path Parameters

display

required

string

Request Body schema: application/json

audioOffsetMillisecond	number 音频偏移时间
autoOffset	boolean 是否自动调整音频偏移
rp	number 调整屏幕分辨率

Responses

200

操作成功

401

用户未登录

403

用户无权限

404

任务不存在

patch /tasks/{display}

https://rec.zukdoor.cloud/api/v1/tasks/{display}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"audioOffsetMillisecond": 0,
"autoOffset": true,
"rp": 0
}

停止任务

path Parameters

display

required

string

Responses

204

成功停止

401

用户未登录

403

用户无权限

404

任务不存在

delete /tasks/{display}

https://rec.zukdoor.cloud/api/v1/tasks/{display}

Request samples

Java

Copy

// Create a task and get id.
client.stopTask(id);

开始录制

path Parameters

display

required

string

Request Body schema: application/json

recordName required	string 录像名称，同一任务中的录像名称不能重复
format	string 录像格式，默认为mkv
onlyAudio	boolean 是否只录制音频，默认为否
storageType	number 0: 默认，1: AWS S3, 2: 阿里云OSS, 3: dropbox, 4: 七牛云
accessKey	string storageType为1, 2, 4需要
secretKey	string storageType为1, 2, 4需要
bucketName	string storageType为1, 2, 4需要
region	string storageType为1, 2, 4需要
accessToken	string storageType为3需要

Responses

202

收到开始录制请求

401

用户未登录

403

用户无权限

404

任务不存在

409

该任务正在录制中或录像名重复

post /tasks/{display}/records

https://rec.zukdoor.cloud/api/v1/tasks/{display}/records

Request samples

Payload
Java

Content type

application/json

Copy

Expand all Collapse all


{"recordName": "string",
"format": "string",
"onlyAudio": true,
"storageType": 0,
"accessKey": "string",
"secretKey": "string",
"bucketName": "string",
"region": "string",
"accessToken": "string"
}

停止录制

path Parameters

display

required

string

Responses

204

成功停止

401

用户未登录

403

用户无权限

404

任务不存在

delete /tasks/{display}/records

https://rec.zukdoor.cloud/api/v1/tasks/{display}/records

Request samples

Java

Copy

// Create a task and start record here.
// Ensure you receive the record started event before calling stopRecording.
client.stopRecording(new StopRecordingRequest(id));

开始推流

path Parameters

display

required

string

Request Body schema: application/json

rtmpUrl

required

Array of strings

推流地址

Responses

202

收到开始推流请求

401

用户未登录

403

用户无权限

404

任务不存在

409

推流地址重复

post /tasks/{display}/rtmps

https://rec.zukdoor.cloud/api/v1/tasks/{display}/rtmps

Request samples

Payload
Java

Content type

application/json

Copy

Expand all Collapse all


{"rtmpUrl": 
["string"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"rtmpId": 0
}

停止推流

path Parameters

display

required

string

Responses

204

停止推流成功

401

用户未登录

403

用户无权限

404

任务不存在

delete /tasks/{display}/rtmps/{rtmpId}

https://rec.zukdoor.cloud/api/v1/tasks/{display}/rtmps/{rtmpId}

Request samples

Java

Copy

// Create a task and start pushing here.
// Ensure you receive the push started event before calling stopPushing.
client.stopRecording(new StopRecordingRequest(id));

模拟鼠标点击

path Parameters

display

required

string

Request Body schema: application/json

x required	number 横坐标
y required	number 纵坐标

Responses

201

模拟点击成功

401

用户未登录

403

用户无权限

404

任务不存在

post /tasks/{display}/clicks

https://rec.zukdoor.cloud/api/v1/tasks/{display}/clicks

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"x": 0,
"y": 0
}

stopped-task

已停止任务相关接口

获取已结束任务信息

query Parameters

pageSize	number 每一页的任务数量
pageNum	number 第几页，从0开始计数

Responses

200

任务信息

get /stopped-tasks

https://rec.zukdoor.cloud/api/v1/stopped-tasks

Response samples

Content type

application/json

Copy

Expand all Collapse all


[null
]

生成录像地址

path Parameters

display required	string
recordName required	string

Request Body schema: application/json

expireTime

required

number

有效期时间，单位为秒

Responses

201

录像url

401

用户未登录

403

用户无权限

404

任务不存在

post /stopped-tasks/{display}/records/{recordName}/urls

https://rec.zukdoor.cloud/api/v1/stopped-tasks/{display}/records/{recordName}/urls

Request samples

Payload
Java

Content type

application/json

Copy

Expand all Collapse all


{"expireTime": 0
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"url": "string"
}

instance

实例相关接口

获取所有运行中实例

Responses

200

所有实例

401

用户未登录

403

用户无权限

get /instances

https://rec.zukdoor.cloud/api/v1/instances

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"region": "string",
"instance": 
{"taskArn": "string",
"ec2InstanceId": "string",
"ip": "string",
"createdTime": "string"
}
}

user

用户相关接口

获取用户统计信息

path Parameters

userId

required

string

query Parameters

periods

required

Array of numbers

查询的时间段，参数形式为[d1, d2, d3, d4]，返回结果为[[d1, d2)的统计信息, [d2, d3)的统计信息, [d3, d4)的统计信息]

Responses

200

操作成功

401

用户未登录

403

用户无权限

get /users/{userId}/statistics

https://rec.zukdoor.cloud/api/v1/users/{userId}/statistics

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"taskNum": 0,
"recordNum": 0,
"totalTaskTimes": 0
}
],
"totalCount": 0
}

获取所有用户统计信息

query Parameters

periods

required

Array of numbers

查询的时间段，参数形式为[d1, d2, d3, d4]，返回结果为[[d1, d2)的统计信息, [d2, d3)的统计信息, [d3, d4)的统计信息]

Responses

200

操作成功

401

用户未登录

403

用户无权限

get /users/statistics

https://rec.zukdoor.cloud/api/v1/users/statistics

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"taskNum": 0,
"recordNum": 0,
"totalTaskTimes": 0
}
],
"totalCount": 0
}

获取用户任务时长分布

path Parameters

userId

required

string

query Parameters

startTime	Array of numbers 查询范围的开始时间
endTime	Array of numbers 查询范围的结束时间
taskTimes required	Array of numbers 时间分布，参数形式为[d1, d2, d3, d4]，返回结果为[长度为[d1, d2)的任务数量, 长度为[d2, d3)的任务数量, 长度为[d3, d4)的任务数量]

Responses

200

操作成功

401

用户未登录

403

用户无权限

get /users/{userId}/taskNums

https://rec.zukdoor.cloud/api/v1/users/{userId}/taskNums

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"taskNum": 0
}
],
"totalCount": 0
}