华为云用户手册

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 处理成功返回。 { "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" }

请求参数 表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参数 参数 是否必选 参数类型 描述 play_domain 是 String 播放域名 app 否 String 应用名称，默认为live delay 是 Integer 延时时间，单位：ms。 包含如下取值： 2000（低）。 4000（中）。 6000（高）。

响应示例 状态码： 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" : "参数校验失败" }

响应示例 状态码： 200 查询录制配置成功 { "id" : "0f78cc406baad9ca3e1fd76656dea1ab", "publish_domain" : "publish.xxx.com", "app" : "live", "stream" : "*", "record_type" : "CONTINUOUS_RECORD", "default_record_config" : { "record_format" : [ "MP4", "FLV" ], "obs_addr" : { "bucket" : "mybucket", "location" : "region1", "object" : "record/" }, "hls_config" : { "record_cycle" : 0, "record_prefix" : "", "record_ts_prefix" : "", "record_slice_duration" : 0, "record_max_duration_to_merge_file" : 0 }, "flv_config" : { "record_cycle" : 3600, "record_prefix" : "Record/publish_domain/app/record_type/record_format/stream_file_start_time/file_start_time", "record_max_duration_to_merge_file" : 0 }, "mp4_config" : { "record_cycle" : 900, "record_prefix" : "Record/publish_domain/app/record_type/record_format/stream_file_start_time/file_start_time", "record_max_duration_to_merge_file" : 0 } }, "create_time" : "2020-05-20T02:13:49.062Z", "update_time" : "0001-01-01T00:00:00Z" } 状态码： 400 查询录制配置失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表4 响应Body参数 参数 参数类型 描述 id String 规则ID，由服务端返回。创建或修改的时候不携带 publish_domain String 直播推流域名 app String 应用名，如果需要匹配任意应用则需填写*。录制规则匹配的时候，优先精确app匹配，如果匹配不到，则匹配* stream String 录制的流名，如果需要匹配任意流名则需填写*。录制规则匹配的时候，优先精确stream匹配，如果匹配不到，则匹配* record_type String 录制类型，包括：CONTINUOUS_RECORD，COMMAND_RECORD。默认CONTINUOUS_RECORD。 CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，即触发录制。 COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过命令控制该流的录制开始和结束。 default_record_config DefaultRecordConfig object 默认录制规则配置 create_time String 创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 update_time String 修改时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 表5 DefaultRecordConfig 参数 参数类型 描述 record_format Array of strings 录制格式，当前支持：FLV，HLS，MP4三种格式，设置格式时必须使用大写字母 obs_addr RecordObsFileAddr object 录制保存的租户的桶信息 hls_config HLSRecordConfig object HLS配置规则 flv_config FLVRecordConfig object FLV配置规则 mp4_config MP4RecordConfig object MP4配置规则 表6 RecordObsFileAddr 参数 参数类型 描述 bucket String OBS的bucket名称 location String OBS Bucket所在RegionID object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表7 HLSRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大12小时（43200秒）。 如果为0，则使用默认值6小时（21600秒）。 record_prefix String 录制m3u8文件,含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} record_ts_prefix String 录制ts文件名的前缀， 默认{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number} record_slice_duration Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2,60] 单位：秒 默认值：10 record_max_duration_to_merge_file Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 单位：秒 默认值：0 0：表示流中断就生成新文件。 -1：表示相同的流中断恢复后，继续在30天内的前一个文件保存。 表8 FLVRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix String 录制FLV文件，含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file Integer 录制FLV文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0 表9 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix String 录制文件含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file Integer 录制mp4文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0 状态码： 400 表10 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表11 响应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 表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 错误描述。

响应示例 状态码： 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" }

URI GET /v2/{project_id}/stats/stream-count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domains 是 Array 推流域名列表，最多支持查询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年。

请求示例 创建录制视频索引。 POST https://{endpoint}/v1/{project_id}/record/indexes { "publish_domain" : "push.example.com", "app" : "live", "stream" : "index", "start_time" : "2022-07-25T16:20:00+08:00", "end_time" : "2022-07-25T16:30:00+08:00", "object" : "Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}" }

接口约束 录制配置中，录制格式必须有HLS，且参数“record_ts_prefix”必须为默认值:{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number}。请求时间段内必须有推送成功的直播流。同一个请求所涉及的录制文件必须在相同的OBS桶中。只允许创建开始时间晚于当前时间前30天的录制索引。如果请求时间段的时长小于HLS录制配置中的ts切片时长，将会返回与请求时间段有时间交集的ts分片，不会对ts文件做裁剪。请求时刻和请求中的开始时间间隔小于一个ts分片时长，可能会因为ts分片未录制完成而请求失败。

响应参数 状态码： 201 表4 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。 格式为 request_id-timestamp-hostname（request_id在服务器端生成UUID， timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表5 响应Body参数 参数 参数类型 描述 index_url String 索引文件地址 publish_domain String 直播推流域名 app String 应用名 stream String 录制的流名 start_time String 开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。(实际视频的开始时间) end_time String 结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。(实际视频的结束时间) duration Integer 录制时长。 单位：秒。 width Integer 视频宽 height Integer 视频高 location String OBS Bucket所在RegionID bucket String 桶名称 object String m3u8文件路径。默认Index/{publish_domain}/{app}/{stream}-{start_time}-{end_time} 状态码： 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户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参数 参数 是否必选 参数类型 描述 publish_domain 是 String 推流域名 app 是 String 应用名 stream 是 String 流名 start_time 是 String 开始时间。格式为：YYYY-MM-DDTHH:mm:ssZ（UTC时间），开始时间与结束时间的间隔最大为12小时。开始时间不允许晚于当前时间。 end_time 是 String 结束时间。格式为：YYYY-MM-DDTHH:mm:ssZ（UTC时间），开始时间与结束时间的间隔最大为12小时。结束时间必须晚于开始时间。 object 否 String m3u8文件在OBS中的储存路径。支持下列字符串的转义 - {publish_domain} - {app} - {stream} - {start_time} - {end_time} - {start_time_unix} - {end_time_unix}其中{start_time},{end_time},{start_time_unix},{end_time_unix}为返回结果的实际时间。 默认值为Index/{publish_domain}/{app}/{stream}/{stream}-{start_time}-{end_time}

响应示例 状态码： 201 创建录制视频索引操作成功 { "index_url" : "http://obs***.com/push.test.com/live/stream01-20220901000000-20220901001000.m3u8", "duration" : 600, "height" : 1080, "width" : 720, "publish_domain" : "push.test.com", "app" : "live", "stream" : "stream01", "start_time" : "2022-09-01T00:00:00Z", "end_time" : "2022-09-01T00:10:00Z", "bucket" : "obs_bucket_name", "location" : "cn-north-5", "object" : "push.test.com/live/stream01-20220901000000-20220901001000.m3u8" } 状态码： 400 创建录制视频索引操作失败，常见错误： illegal time range：请求时间范围有误，请查看start_time，end_time参数限制； no record info found：请求时间段内没有录制任务，可能是时间段内没有成功推送的直播流或命令录制规则下未启动命令录制； no ts info found：请求时间段内没有ts文件，可能是请求时间段推流有断流或请求时ts切片文件还没录制结束。 { "error_code" : "LIVE.100011001", "error_msg" : "参数校验失败" }

状态码 状态码 描述 201 创建录制视频索引操作成功 400 创建录制视频索引操作失败，常见错误： illegal time range：请求时间范围有误，请查看start_time，end_time参数限制； no record info found：请求时间段内没有录制任务，可能是时间段内没有成功推送的直播流或命令录制规则下未启动命令录制； no ts info found：请求时间段内没有ts文件，可能是请求时间段推流有断流或请求时ts切片文件还没录制结束。

请求示例 修改录制规则。 PUT https://{endpoint}/v1/{project_id}/record/rule/e89b76xxxxxx3425ui80af501cdxxxxxx { "publish_domain" : "publish.xxx.com", "app" : "live", "stream" : "*", "record_type" : "CONTINUOUS_RECORD", "default_record_config" : { "record_format" : [ "HLS", "FLV" ], "hls_config" : { "record_cycle" : 3600, "record_prefix" : "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}", "record_ts_prefix" : "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}", "record_slice_duration" : 10, "record_max_duration_to_merge_file" : 0 }, "flv_config" : { "record_cycle" : 9000, "record_prefix" : "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}", "record_max_duration_to_merge_file" : 0 }, "obs_addr" : { "bucket" : "mybucket", "location" : "region1", "object" : "record/" } } }

响应参数 状态码： 200 表9 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表10 响应Body参数 参数 参数类型 描述 id String 规则ID，由服务端返回。创建或修改的时候不携带 publish_domain String 直播推流域名 app String 应用名，如果需要匹配任意应用则需填写*。录制规则匹配的时候，优先精确app匹配，如果匹配不到，则匹配* stream String 录制的流名，如果需要匹配任意流名则需填写*。录制规则匹配的时候，优先精确stream匹配，如果匹配不到，则匹配* record_type String 录制类型，包括：CONTINUOUS_RECORD，COMMAND_RECORD。默认CONTINUOUS_RECORD。 CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，即触发录制。 COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过命令控制该流的录制开始和结束。 default_record_config DefaultRecordConfig object 默认录制规则配置 create_time String 创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 update_time String 修改时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 表11 DefaultRecordConfig 参数 参数类型 描述 record_format Array of strings 录制格式，当前支持：FLV，HLS，MP4三种格式，设置格式时必须使用大写字母 obs_addr RecordObsFileAddr object 录制保存的租户的桶信息 hls_config HLSRecordConfig object HLS配置规则 flv_config FLVRecordConfig object FLV配置规则 mp4_config MP4RecordConfig object MP4配置规则 表12 RecordObsFileAddr 参数 参数类型 描述 bucket String OBS的bucket名称 location String OBS Bucket所在RegionID object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表13 HLSRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大12小时（43200秒）。 如果为0，则使用默认值6小时（21600秒）。 record_prefix String 录制m3u8文件,含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} record_ts_prefix String 录制ts文件名的前缀， 默认{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number} record_slice_duration Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2,60] 单位：秒 默认值：10 record_max_duration_to_merge_file Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 单位：秒 默认值：0 0：表示流中断就生成新文件。 -1：表示相同的流中断恢复后，继续在30天内的前一个文件保存。 表14 FLVRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix String 录制FLV文件，含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file Integer 录制FLV文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0 表15 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix String 录制文件含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file Integer 录制mp4文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0 状态码： 400 表16 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表17 响应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参数 参数 是否必选 参数类型 描述 publish_domain 是 String 直播推流域名 app 是 String 应用名，如需匹配任意应用则填写*。录制规则匹配的时候，优先精确app匹配，如果匹配不到，则匹配* stream 是 String 录制的流名，如需匹配任流名则填写*。录制规则匹配的时候，优先精确stream匹配，如果匹配不到，则匹配* record_type 否 String 录制类型，包括：CONTINUOUS_RECORD，COMMAND_RECORD。默认CONTINUOUS_RECORD。 CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，就触发录制。 COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过命令控制该流的录制开始和结束。 default_record_config 是 DefaultRecordConfig object 默认录制规则配置 表4 DefaultRecordConfig 参数 是否必选 参数类型 描述 record_format 是 Array of strings 录制格式，当前支持：FLV，HLS，MP4三种格式，设置格式时必须使用大写字母 obs_addr 是 RecordObsFileAddr object 录制保存的租户的桶信息 hls_config 否 HLSRecordConfig object HLS配置规则 flv_config 否 FLVRecordConfig object FLV配置规则 mp4_config 否 MP4RecordConfig object MP4配置规则 表5 RecordObsFileAddr 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称 location 是 String OBS Bucket所在RegionID object 是 String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表6 HLSRecordConfig 参数 是否必选 参数类型 描述 record_cycle 是 Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大12小时（43200秒）。 如果为0，则使用默认值6小时（21600秒）。 record_prefix 否 String 录制m3u8文件,含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} record_ts_prefix 否 String 录制ts文件名的前缀， 默认{file_start_time_unix}_{file_end_time_unix}_{ts_sequence_number} record_slice_duration 否 Integer 录制HLS时ts的切片时长，非必填。 取值范围：[2,60] 单位：秒 默认值：10 record_max_duration_to_merge_file 否 Integer 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件。 单位：秒 默认值：0 0：表示流中断就生成新文件。 -1：表示相同的流中断恢复后，继续在30天内的前一个文件保存。 表7 FLVRecordConfig 参数 是否必选 参数类型 描述 record_cycle 是 Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix 否 String 录制FLV文件，含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file 否 Integer 录制FLV文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0 表8 MP4RecordConfig 参数 是否必选 参数类型 描述 record_cycle 是 Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大6小时（21600秒）。 如果为0，则使用默认值2小时（7200秒）。 record_prefix 否 String 录制文件含路径和文件名的前缀， 默认Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time} record_max_duration_to_merge_file 否 Integer 录制mp4文件拼接时长，如果流中断超过该时间，则生成新文件。如果为0表示流中断就生成新文件。 单位：秒 默认值：0

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 url 是 String 回调地址 auth_sign_key 否 String 鉴权密钥 call_back_area 否 String 接收回调通知服务器所在区域。 包含如下取值： mainland_china：中国大陆区域。 outside_mainland_china：中国大陆以外区域。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 framerate_info_list Array of V2FramerateInfo objects 用量详情。 表6 V2FramerateInfo 参数 参数类型 描述 publish_domain String 推流域名。 app String 应用名称。 stream String 流名。 start_time String 采样开始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 end_time String 采样结束时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 data_list Array of longs 帧率信息列表，单位为fps。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应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信息，与路径参数中的项目ID相同。

响应示例 状态码： 200 处理成功返回。 { "framerate_info_list" : [ { "publish_domain" : "livepush-test.huaweicloud.com", "app" : "live", "stream" : "pull", "start_time" : "2020-06-04T07:00:00Z", "end_time" : "2020-06-05T07:00:00Z", "data_list" : [ 10, 20 ] } ] } 状态码： 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domain" }

URI GET /v2/{project_id}/stats/stream/framerate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名。 app 是 String App名。 stream 是 String 流名。 start_time 否 String 起始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天，最大查询周期7天。 若参数为空，默认查询最近1小时数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 若参数为空，默认为当前时间。结束时间需大于起始时间。

响应示例 状态码： 200 处理成功返回。 { "data_list" : [ { "value" : 50, "time" : "2020-06-04T07:00:00Z" }, { "value" : 78, "time" : "2020-06-04T07:05:00Z" } ] } 状态码： 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: start_time" }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 data_list Array of TrafficData objects 采样数据列表。 表6 TrafficData 参数 参数类型 描述 value Long 采样值，单位为byte。 time String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应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信息, 与路径参数中的项目ID相同。

URI GET /v2/{project_id}/stats/traffic/detail 表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 请求协议 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参数 参数 参数类型 描述 snapshot_list Array of SnapshotData objects 采样数据列表。 total Long 指定时间区间内截图数量总和。 表6 SnapshotData 参数 参数类型 描述 count Long 每小时内截图总数，单位为张。 time String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ 。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。