华为云用户手册

  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • URI GET /v2/{project_id}/stats/stream/play-info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 否 Array of strings 播放 域名 列表,最多支持查询10个域名,多个域名以逗号分隔。 如果不传入域名,则查询租户下所有播放域名的流数据。 time 是 String 查询数据的时间点,精确到分钟。 日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ,最大查询周期七天。 时间必须为时间粒度整时刻点,如:2024-02-02T08:01:00Z。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 状态码:400 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必填,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填,携带项目ID信息。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名或播放域名 auth_type 是 String 鉴权类型。 包含如下取值: WHITE:IP白名单鉴权。 BLACK:IP黑名单鉴权。 NONE:不鉴权。 ip_auth_list 是 String IP黑名单列表,IP之间用;分隔,如192.168.0.0;192.168.0.8,最多支持配置100个IP。支持IP网段添加,例如127.0.0.1/24表示采用子网掩码中的前24位为有效位,即用32-24=8bit来表示主机号,该子网可以容纳2^8 - 2 = 254 台主机。故127.0.0.1/24 表示IP网段范围是:127.0.0.1~127.0.0.255
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 domain String 直播域名 guard_switch String referer防盗链开关:true表示开启;false表示关闭 referer_config_empty String 是否包含referer头域:true表示包含;false表示不包含;guard_switch为true则必填 referer_white_list String 是否为referer白名单:true表示白名单;false表示黑名单;guard_switch为true则必填 referer_auth_list Array of strings 域名列表,域名为正则表达式;最多支持配置100个域名,以英文“;”进行分隔;guard_switch为true则必填 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必填,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填,携带项目ID信息。
  • 响应示例 状态码:200 查询Referer黑白名单成功 { "domain" : "play.example.huawei.com", "guard_switch" : "true", "referer_config_empty" : "true", "referer_white_list" : "false", "referer_auth_list" : [ "^http://test.*com$", "abc.com" ] } 状态码:400 查询Referer黑白名单失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
  • 响应参数 状态码:204 表3 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 状态码:400 表4 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码:404 表6 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必填,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填,携带项目ID信息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • 响应示例 状态码:200 处理成功返回。 { "data_series" : [ { "time" : "2020-06-04T07:00:00Z", "http_codes" : [ { "code" : 200, "count" : 750, "proportion" : 0.5211 }, { "code" : 400, "count" : 650, "proportion" : 0.4789 } ] }, { "time" : "2020-06-04T07:01:00Z", "http_codes" : [ { "code" : 200, "count" : 1000, "proportion" : 1 }, { "code" : 400, "count" : 0, "proportion" : 0 } ] } ] } 状态码:400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domains" }
  • URI GET /v2/{project_id}/stats/httpcodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 是 Array of strings 播放域名列表,最多支持查询100个域名,多个域名以逗号分隔。 code 否 Array of strings 状态码。 region 否 Array of strings 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array of strings 运营商列表,取值如下: CMCC :移动 CTCC : 电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。若参数为空,默认查询最近1小时数据。 最大查询跨度1天,最大查询周期7天。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间。结束时间需大于起始时间。 最大查询跨度1天,最大查询周期7天。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 data_series Array of HttpCodeSummary objects 基于时间轴的状态码 表6 HttpCodeSummary 参数 参数类型 描述 http_codes Array of HttpCode objects 状态码信息 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ 。 表7 HttpCode 参数 参数类型 描述 code Integer 状态码 count Integer 状态码出现次数 proportion Double 状态码在对应时间点中的占比,保留4位小数。 状态码:400 表8 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: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" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必填,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填,携带项目ID信息。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 total Integer 查询结果的总元素数量 blocks Array of StreamForbiddenList objects 禁推黑名单列表 表5 StreamForbiddenList 参数 参数类型 描述 app_name String 应用名称 stream_name String 流名称 resume_time String 恢复流时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间,不指定则默认7天,最大禁推为90天 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/stream/blocks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 域名 app_name 否 String 应用名称,不指定则查询domain下所有应用的禁止直播推流信息 stream_name 否 String 流名称 page 否 Integer 分页编号。 默认为0。 size 否 Integer 每页记录数。 取值范围:1-100。 默认为10。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必填,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必填,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必填,携带项目ID信息。 表4 请求Body参数 参数 是否必选 参数类型 描述 app 是 String 应用名 area_whitelist 否 Array of strings 限制区域列表, 空列表表示不限制。 除中国以外,其他地区代码,2位字母大写。代码格式参考ISO 3166-1 alpha-2 包含如下部分取值: CN-IN:中国大陆 CN-HK:中国香港 CN-MO:中国澳门 CN-TW:中国台湾 BR:巴西
  • 响应参数 状态码:200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 状态码:400 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 处理成功返回。 { "stream_portraits" : [ { "time" : 20200812, "flow" : 10, "play_duration" : 10, "request_count" : 10, "user_count" : 10, "peak_user_count" : 10, "peak_bandwidth" : 10, "push_duration" : 10 } ] } 状态码:400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domain" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 stream_portraits Array of StreamPortrait objects 播放画像信息列表。 表6 StreamPortrait 参数 参数类型 描述 time String 统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。统计该统计日期00:00-23:59时段的播放画像信息。 flow Long 累计流量,单位为byte。 play_duration Long 累计播放时长,单位为秒。 request_count Long 累计请求次数。 user_count Long 累计观看人数,根据IP去重。 peak_user_count Long 峰值观看人数,flv/rtmp协议是统计Session会话ID,其它协议统计IP,1分钟的采样数据。 peak_bandwidth Long 峰值带宽,单位bps,5分钟的采样数据。 push_duration Long 累计直播(推流)时长,单位为秒。 状态码:400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v2/{project_id}/stats/stream-portraits 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domain 是 String 播放域名。 stream 否 String 流名。 time 是 String 统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。可以查询过去31天的数据(不含当天)。
  • 响应示例 状态码:200 获取URL鉴权串成功 { "keychain" : [ "http://pull.domain.com/live/stream.flv?secret=xxx&time=ttt", "rtmp://pull.domain.com/live/stream?secret=xxx&time=ttt" ] } 状态码:400 获取URL鉴权串失败 { "error_code" : "LIVE.100011001", "error_msg" : "参数校验失败" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 data_list Array of StreamCountData objects 采样数据列表。 表6 StreamCountData 参数 参数类型 描述 value Integer 采样时间点的推流路数。 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 状态码:400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v2/{project_id}/stats/stream-count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domains 是 Array of strings 推流域名列表,最多支持查询100个域名,多个域名以逗号分隔,若查询多个域名,则返回的是多个域名合并数据。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期1年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间,最大查询跨度31天, 最大查询跨度31天,最大查询周期1年。
  • 响应示例 状态码:200 处理成功返回。 { "data_list" : [ { "time" : "2020-06-04T07:00:00Z", "value" : 0 }, { "time" : "2020-06-04T07:05:00Z", "value" : 325 } ] } 状态码:400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domain" }
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表5 响应Body参数 参数 参数类型 描述 domain String 推流域名或播放域名 auth_type String 鉴权类型。 包含如下取值: WHITE:IP白名单鉴权。 BLACK:IP黑名单鉴权。 NONE:不鉴权。 ip_auth_list String IP黑名单列表,IP之间用;分隔,如192.168.0.0;192.168.0.8,最多支持配置100个IP。支持IP网段添加,例如127.0.0.1/24表示采用子网掩码中的前24位为有效位,即用32-24=8bit来表示主机号,该子网可以容纳2^8 - 2 = 254 台主机。故127.0.0.1/24 表示IP网段范围是:127.0.0.1~127.0.0.255 状态码:400 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 查询IP黑/白名单成功 { "domain" : "play.example.huawei.com", "auth_type" : "WHITE", "ip_auth_list" : "192.168.0.0;192.168.0.8" } 状态码:400 查询IP黑/白名单失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全