查询录制回调配置列表
功能介绍
查询录制回调配置列表接口。通过指定条件，查询满足条件的配置列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/record/callbacks
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
publish_domain |
否 |
String |
直播推流域名 |
app |
否 |
String |
流应用名称 |
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询，offset大于等于0 |
limit |
否 |
Integer |
每页记录数，取值范围[1,100]，默认值10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） |
参数 |
参数类型 |
描述 |
|---|---|---|
total |
Integer |
查询结果的总元素数量 |
callback_config |
Array of RecordCallbackConfig objects |
转码模板 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
配置规则ID，在创建配置规则成功后服务端返回 |
publish_domain |
String |
直播推流域名 |
app |
String |
app名称。如果需要匹配任意应用则需填写*。录制规则匹配的时候，优先精确app匹配，如果匹配不到，则匹配* |
notify_callback_url |
String |
录制回调通知url地址 |
notify_event_subscription |
Array of strings |
订阅录制通知消息。消息类型。RECORD_NEW_FILE_START开始创建新的录制文件。RECORD_FILE_COMPLETE录制文件生成完成。RECORD_OVER录制结束。RECORD_FAILED表示录制失败。如果不填写,默认订阅RECORD_FILE_COMPLETE |
sign_type |
String |
加密类型 |
create_time |
String |
创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 |
update_time |
String |
修改时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-id |
String |
此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） |
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v1/{project_id}/record/callbacks?publish_domain=publish.xxx.com
响应示例
状态码： 200
查询录制回调成功
{
"total" : 1,
"callback_config" : [ {
"id" : "e2fe84def7e476651034ec4b9e92bc30",
"publish_domain" : "publish.xxx.com",
"app" : "*",
"notify_callback_url" : "http://100.95.129.234:8456/base_record_notify",
"notify_event_subscription" : [ "RECORD_FILE_COMPLETE", "RECORD_NEW_FILE_START" ],
"key" : "ca3e25e5dc17a6f9909a9ae7281e300d",
"create_time" : "2020-03-02T08:59:45Z",
"update_time" : "2020-03-09T08:59:45Z"
} ]
}
状态码： 400
查询录制回调失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询录制回调成功 |
400 |
查询录制回调失败 |
错误码
请参见错误码。
