查询录制规则
功能介绍
查询录制规则
接口约束
URI
POST /openapi/v1/rtcLive/queryRuleList
请求参数
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
appId |
String |
Y |
应用ID |
|
ruleId |
Long |
N |
录制规则ID |
|
recordingType |
String |
N |
录制类型 |
|
recordingModel |
String |
N |
录制模式 |
|
pageSize |
Integer |
N |
显示条数 |
|
pageNo |
Integer |
N |
当前页数 |
表8.7.4-1请求参数
响应参数
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
errorCode |
int |
|
状态码 |
请参考错误码为空说明成功 |
errorMessage |
String |
|
消息内容 |
SUCCESS,FAIL |
timestamp |
String |
|
时间 |
|
data |
Object |
|
响应内容 |
见data参数 |
表8.7.4-2响应参数
参数data
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
list |
List<Object> |
Y |
列表数据 |
|
pos |
Integer |
N |
当前页码 |
|
totalCount |
Integer |
N |
总数 |
表8.7.4-3参数data
参数List<Object>
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
appId |
String |
Y |
应用ID |
|
ruleId |
Long |
Y |
录制规则ID |
|
storageType |
Integer |
Y |
存储类型 |
|
recordPath |
String |
N |
存储路径 |
|
captureInterval |
Integer |
N |
截帧间隔 |
|
captureNums |
Integer |
N |
截帧数量 |
|
recordingType |
Integer |
Y |
录制类型 |
|
callbackUrl |
String |
Y |
回调URL |
|
extraData |
String |
N |
透传参数 |
|
recordingModel |
Integer |
Y |
录制模式 |
|
basePath |
String |
Y |
存储路径 |
|
mixingEnabled |
String |
N |
录制模式 |
|
status |
Boolean |
Y |
true 启用 false 不启用 |
表8.7.4-4参数List<Object>
请求示例
{
"pageSize":10,
"appId":"****",
"ruleId":1001,
"pageNo":1
}
响应示例
成功返回示例：
{
"errorCode": 0,
"errorMessage": null,
"data": {
"list": [
{
"ruleId": 11,
"storageType": "NAS",
"recordPath": "/saas/application",
"captureInterval": null,
"captureNums": null,
"recordingType": 0,
"callbackUrl": "https://www.iqiyi.com",
"extraData": null,
"recordingModel": 1,
"status": true,
"appId": "****",
"mixingEnabled": 0,
"basePath": "D://root"
}
],
"pos": 1,
"totalCount": 1
},
"timestamp": "2022-03-02T18:35:58.236+0800"
}
错误示例：
{
"errorCode":1001001,
"errorMessage":"PARAM_IS_INVALID",
"timestamp":"2021-12-15T18:41:14.369+0800",
"data":null
}
