7.1 禁止直播推流
功能介绍
禁止直播推流
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/stream/blocks
表7-1 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
请求参数
表7-2 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
表7-3 请求 Body 参数
参数 是否必选 参数类型 描述
domain 是 String 推流域名
app_name 是 String 应用名称
stream_name 是 String 流名称
resume_time 否 String 恢复流时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间，不 指定则默认7天，最大禁推为90 天
响应参数
状态码： 400
表7-4 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
POST https://{endpoint}/v1/{project_id}/stream/blocks { "domain" : "publish.example.huawei.com",
"app_name" : "live", "stream_name" : "huawei",
"resume_time" : "2018-05-19T21:10:15Z"
}
响应示例
状态码： 400
设置禁止直播推流操作失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
204 设置禁止直播推流操作成功 400 设置禁止直播推流操作失败
错误码
请参见错误码。
7.2 查询禁止直播推流列表
功能介绍
查询禁推黑名单列表
调试
您可以在API Explorer中调试该接口。
URI
GET /v1/{project_id}/stream/blocks
表7-5 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表7-6 Query 参数
参数 是否必选 参数类型 描述
domain 是 String 推流域名
参数 是否必选 参数类型 描述
app_name 否 String 应用名称，不指定则查询
domain下所有应用的禁止直播 推流信息
stream_name 否 String 流名称
page 否 Integer 分页编号。 默认为0。
size 否 Integer 每页记录数。
取值范围：1-100。
默认为10。
请求参数
表7-7 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
响应参数
状态码： 200
表7-8 响应 Body 参数
参数 参数类型 描述
total Integer 查询结果的总元素数量 blocks Array of
StreamForbid denList objects
禁推黑名单列表
表7-9 StreamForbiddenList
参数 参数类型 描述
app_name String 应用名称 stream_name String 流名称
参数 参数类型 描述
resume_time String 恢复流时间，格式：yyyy-mm-ddThh:mm:ssZ，
UTC时间，不指定则默认7天，最大禁推为90天
状态码： 400
表7-10 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
GET https://{endpoint}/v1/{project_id}/stream/blocks?domain=publish.example.huawei.com&app_name=live
响应示例
状态码： 200
查询禁止直播推流列表成功
{ "total" : 2, "blocks" : [ { "app_name" : "live", "stream_name" : "test_001",
"resume_time" : "2018-05-19T21:10:15Z"
}, {
"app_name" : "live", "stream_name" : "test_002",
"resume_time" : "2018-06-12T20:10:10Z"
} ] }
状态码： 400
查询禁止直播推流列表失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
200 查询禁止直播推流列表成功 400 查询禁止直播推流列表失败
错误码
请参见错误码。
7.3 禁推恢复
功能介绍
恢复直播推流接口
调试
您可以在API Explorer中调试该接口。
URI
DELETE /v1/{project_id}/stream/blocks
表7-11 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
表7-12 Query 参数
参数 是否必选 参数类型 描述
domain 是 String 推流域名
app_name 是 String 应用名称
stream_name 是 String 流名称
请求参数
表7-13 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
响应参数
状态码： 400
表7-14 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
DELETE https://{endpoint}/v1/{project_id}/stream/blocks?
domain=publish.example.huawei.com&app_name=live&stream_name=test_001
响应示例
状态码： 400 禁推恢复操作失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
204 禁推恢复操作成功 400 禁推恢复操作失败
错误码
请参见错误码。
7.4 修改禁推属性
功能介绍
修改禁推属性
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/stream/blocks
表7-15 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 项目ID，获取方法请参考获取项 目ID。
请求参数
表7-16 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token，使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取（响应消 息头中X-Subject-Token的 值）。
表7-17 请求 Body 参数
参数 是否必选 参数类型 描述
domain 是 String 推流域名
app_name 是 String 应用名称
stream_name 是 String 流名称
resume_time 否 String 恢复流时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间，不 指定则默认7天，最大禁推为90 天
响应参数
状态码： 400
表7-18 响应 Body 参数
参数 参数类型 描述
error_code String 错误码 error_msg String 错误描述
请求示例
POST https://{endpoint}/v1/{project_id}/stream/blocks { "domain" : "publish.example.huawei.com",
"app_name" : "live", "stream_name" : "huawei",
"resume_time" : "2018-05-19T21:10:15Z"
}
响应示例
状态码： 400
修改禁推属性操作失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"
}
状态码
状态码 描述
204 修改禁推属性操作成功 400 修改禁推属性操作失败
错误码
请参见错误码。