华为云用户手册

  • URI GET /v2/{project_id}/stats/record 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domain 否 String 推流域名。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。非整点时间按小时取整,若start_time为2020-08-18T07:20:40Z,则实际查询起始时间为2020-08-18T07:00:00Z。若start_time为空,则默认查询最近24小时数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。非整点时间按小时取整,若end_time为2020-08-18T08:20:40Z,则实际查询起始时间为2020-08-18T08:00:00Z。若参数为空,默认为当前时间。结束时间需大于起始时间。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 record_data_list Array of RecordData objects 采样数据列表。 表6 RecordData 参数 参数类型 描述 concurrent_count 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 错误描述。
  • 响应示例 状态码: 200 查询直播中的流信息数据成功 { "total_page" : 1, "total_num" : 10, "offset" : 0, "limit" : 10, "request_id" : "56b9f4dc-b282-48e0-a1a9-c50ffb06b687", "streams" : [ { "publish_domain" : "push.example.huawei.com", "app" : "live", "stream" : "test", "video_codec" : "H264", "audio_codec" : "AAC", "video_frame_rate" : 15, "audio_frame_rate" : 43, "video_bitrate" : 588, "audio_bitrate" : 68, "resolution" : "640x360", "client_ip" : "192.168.0.100", "start_time" : "2006-01-02T15:04:05Z" } ]} 状态码: 400 查询直播中的流信息数据失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_page Long 总页数 total_num Long 总条目数 offset Long 偏移量 limit Long 每页条目数 request_id String 请求唯一标识 streams Array of OnlineInfo objects 推流统计 表5 OnlineInfo 参数 参数类型 描述 publish_domain String 域名 app String 应用名 stream String 流名 video_codec String 视频编码方式 H264 H265 audio_codec String 音频编码方式:AAC video_frame_rate Long 视频帧率(单位:fps) audio_frame_rate Long 音频帧率(单位:fps) video_bitrate Long 视频码率(单位:Kbps) audio_bitrate Long 音频码率(单位:Kbps) resolution String 视频分辨率 client_ip String 推流设备的ip start_time String 开始推流的时间,UTC格式:2006-01-02T15:04:05Z 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/realtime/streams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domain 是 String 推流域名 app 否 String 应用名 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0 limit 否 Integer 每页记录数,取值范围[1,100],默认值10 stream 否 String 流名,用于单流查询,携带stream参数时app不能缺省
  • 请求参数 表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信息。
  • 请求参数 表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参数 参数 参数类型 描述 history_stream_list Array of HistoryStreamInfo objects 历史流信息列表。 total Integer 总记录数。 表6 HistoryStreamInfo 参数 参数类型 描述 domain String 推流域名。 type为0表主播推流域名。 type为1表示第三方推流域名 app String 应用名称。 stream String 流名。 type Integer 推流类型,取值如下: 0:表示主播推流 1:表示第三方推流 video_codec String 视频编码格式。 audio_codec String 音频编码格式。 client_ip String 主播ip。 start_time String 采样开始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 end_time String 采样结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "history_stream_list" : [ { "domain" : "example.xxx.com", "app" : "live", "stream" : "pull", "type" : 0, "video_codec" : "H264", "audio_codec" : "AAC", "client_ip" : "127.0.0.1", "start_time" : "2020-06-04T07:00:00Z", "end_time" : "2020-06-05T07:00:00Z" } ], "total" : 100} 状态码: 400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domain"}
  • URI GET /v2/{project_id}/stats/history/streams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名。 app 否 String 应用名称。 stream 否 String 流名称。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天。 若参数为空,默认查询1天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间,最大查询跨度1天。结束时间需大于起始时间。 offset 否 Integer 分页编号,默认为0 limit 否 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信息, 与路径参数中的项目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 播放域名列表,最多支持查询100个域名, 多个域名 以逗号分隔。 code 否 Array 状态码。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array 运营商列表,取值如下: 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" : 1, "domain" : "play.example.huawei.com", "logs" : [ { "name" : "play.example.huawei.com_20200304160000.log.gz", "url" : "https://xxxxxxxxx/play.example.huawei.com_20200304160000.log.gz", "size" : 600, "start_time" : "2020-03-04T16:00:00+08:00", "end_time" : "2020-03-04T16:04:59+08:00" } ]} 状态码: 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 符合查询条件的总条目数 domain String 播放域名 logs Array of LogInfo objects 日志信息列表 表5 LogInfo 参数 参数类型 描述 name String 日志文件名,打包文件名格式:{Domain}_{logStartTimeStamp}.log.gz url String 日志下载链接 size Long 日志文件大小 start_time String 日志文件中日志开始时间,北京时间 end_time String 日志文件中日志结束时间,北京时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domain 是 String 播放域名。 start_time 是 String 查询开始时间,UTC时间:YYYY-MM-DDTHH:mm:ssZ,如北京时间2020年3月4日16点00分00秒可表示为2020-03-04T08:00:00Z。仅支持查询最近3个月内的数据。 end_time 是 String 查询结束时间,UTC时间:YYYY-MM-DDTHH:mm:ssZ,如北京时间2020年3月4日16点00分00秒可表示为2020-03-04T08:00:00Z。查询时间跨度不能大于7天。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 traffic_list Array of TrafficSummaryData objects 域名对应的流量汇总列表。 表6 TrafficSummaryData 参数 参数类型 描述 value Long 流量,单位为byte。 domain String 域名。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "traffic_list" : [ { "value" : 2300, "domain" : "example.xxx.com" } ]} 状态码: 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domains"}
  • URI GET /v2/{project_id}/stats/traffic/summary 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 否 Array 播放域名列表,最多支持查询100个域名,多个域名以逗号分隔。 如果不传入域名,则查询租户下所有播放域名的流量汇总。 app 否 String 应用名称。 stream 否 String 流名。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array 运营商列表。取值如下: CMCC :移动 CTCC : 电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 protocol 否 String 请求协议 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期一年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间。结束时间需大于起始时间。 service_type 否 String 服务类型,取值如下: Live :标准直播 LLL :低时延直播 ALL :所有服务类型 不填写默认查询所有服务类型的数据。 说明: 该参数只对2022年12月15日后的数据生效。
  • 请求参数 表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相同。
  • 请求参数 表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/bandwidth/peak 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 否 Array 播放域名列表,最多支持查询100个域名,多个域名以逗号分隔。 如果不传入域名,则查询租户下所有播放域名的带宽峰值。 app 否 String 应用名称。 stream 否 String 流名。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array 运营商列表,取值如下: CMCC :移动 CTCC : 电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 protocol 否 String 请求协议 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期一年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间。结束时间需大于起始时间。 service_type 否 String 服务类型,取值如下: Live :标准直播 LLL :低时延直播 ALL :所有服务类型 不填写默认查询所有服务类型的数据。 说明: 该参数只对2022年12月15日后的数据生效。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 bandwidth_list Array of PeakBandwidthData objects 域名对应的带宽峰值列表。 表6 PeakBandwidthData 参数 参数类型 描述 value Long 带宽峰值,单位为bps。 domain String 播放域名。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "bandwidth_list" : [ { "value" : 50, "domain" : "example.xxx.com" } ]} 状态码: 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domains"}
  • 响应示例 状态码: 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: play_domains"}
  • 请求参数 表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/bandwidth/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 否 Array 播放域名列表,最多支持查询100个域名,多个域名以逗号分隔。 如果不传入域名,则查询租户下所有播放域名的带宽数据。 app 否 String 应用名称。 stream 否 String 流名。 country 否 Array 国家列表。具体取值请参考国家名称缩写,不填写查询所有国家。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array 运营商列表,取值如下: CMCC :移动 CTCC :电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 protocol 否 String 请求协议 interval 否 Integer 查询数据的时间粒度。支持300(默认值), 3600和86400秒。不传值时,使用默认值300秒。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期一年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间。结束时间需大于起始时间。 service_type 否 String 服务类型,取值如下: Live :标准直播 LLL :低时延直播 ALL :所有服务类型 不填写默认查询所有服务类型的数据。 说明: 该参数只对2022年12月15日后的数据生效。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 data_list Array of V2BandwidthData objects 采样数据列表 表6 V2BandwidthData 参数 参数类型 描述 value Long 带宽值,单位为bps。 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
共100000条