华为云用户手册

请求参数 表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信息。

修订记录 表1 修订记录 发布日期 修改说明 2024-02-23 第五十一次发布： 本次变更如下： 修改创建录制规则和修改录制规则接口FLV、MP4格式的“record_cycle” 字段最大值。 2023-09-19 第五十次发布： 本次变更如下： 修改转码模板管理组接口。请求参数新增字段bitrate_adaptive和i_frame_policy，并更新字段templateName、PVC、hdlb、width、height、iFrameInterval、gop的参数说明。 2023-07-24 第四十九次发布： 本次变更如下： 修改查询转码用量接口，增加按小时结算的资源出账描述和请求示例。 修改查询直播各区域指标分布接口，增加查询数据用于对账，查询三个小时之前的描述。 修改创建录制视频索引文件接口，补充接口约束说明和状态码描述，补充“start_time”和“end_time”参数说明。 2023-05-12 第四十八次发布： 本次变更如下： 增加错误码LIVE.100011022。 2023-05-06 第四十七次发布： 本次变更如下： 修改查询播放流量汇总接口描述，增加查询数据会延迟10分钟左右的描述。 2023-04-23 第四十六次发布： 本次变更如下： 修改查询转码用量接口描述，增加转码数据延时1小时的描述。 2023-04-18 第四十五次发布： 本次变更如下： 调整查询直播各区域指标分布接口的用户和API流量限制，用户流量限制由1次/秒变更为50次/秒，API流量限制由5次/秒变更为150次/秒。 2023-03-21 第四十四次发布： 本次变更如下： 新增鉴权、截图、HTTPS证书和OBS桶管理接口组。 修改创建录制规则和修改录制规则接口的“default_record_config”、“hls_config”和 “record_cycle” 字段的默认值。 2023-02-09 第四十三次发布： 本次变更如下： 修改创建录制规则和修改录制规则接口的“record_prefix”、“record_ts_prefix”参数的描述。 2023-01-18 第四十二次发布： 本次变更如下： 创建直播转码模板、创建录制规则接口新增计费说明。 “使用前必读”章节新增 域名 管理接口流控限制。 2023-01-06 第四十一次发布： 本次变更如下： 新增查询CDN上行推流质量数据接口。 修改查询播放带宽趋势、查询播放流量趋势、查询播放带宽峰值和查询播放流量汇总接口的“play_domains”参数为非必填。 查询播放带宽趋势、查询播放流量趋势、查询播放带宽峰值、查询播放流量汇总和查询流维度的观众趋势接口新增“service_type”参数。 查询上行带宽数据接口新增“type”参数。 2022-12-29 第四十次正式发布： 本次变更如下： 修改地区/国家代码对照表。 2022-12-27 第三十九次正式发布 本次变更如下： 新增查询直播各区域指标分布接口。 删除上行带宽数据接口“type”参数。 创建录制回调配置、修改录制回调配置接口增加成功状态的响应参数、请求参数key。 修改配置域名IPV6开关接口的请求示例。 修改地区/国家代码对照表。 2022-12-20 第三十八次正式发布 本次变更如下： 查询上行带宽数据接口新增“type”参数。 2022-12-07 第三十七次正式发布 本次变更如下： v1接口增加AK/SK鉴权头域。 下线查询直播各区域指标分布接口。 2022-11-08 第三十六次正式发布 本次变更如下： 删除查询播放带宽趋势接口中的“service_type”参数。 2022-09-29 第三十五次正式发布 本次变更如下： 删除录制回调管理接口中的“call_back_ssl_ca”和“call_back_ssl_verify”参数。 2022-09-27 第三十四次正式发布 本次变更如下： 修改查询录制规则配置接口的示例代码，删除“start_time”、“project_id”和“end_time”参数。 2022-09-08 第三十三次正式发布： 本次变更如下： 修改地区/国家代码对照表。 2022-09-06 第三十二次正式发布： 本次变更如下： 录制管理接口组新增创建录制视频索引文件接口。 2022-08-26 第三十一次正式发布： 本次变更如下： 修改查询直播各区域指标分布接口的“area”字段描述和返回体中的“name”字段描述。 修改查询转码用量接口、查询录制用量接口和查询截图用量接口的最大查询周期为1年。 新增地区/国家代码对照表。 2022-07-05 第三十次正式发布： 本次变更如下： 查询播放带宽趋势接口新增“service_type”参数。 所有接口中的响应Header参数“X-request-id”修改为“X-Request-Id”。 修改查询直播域名接口的响应示例。 2022-07-01 第二十九次正式发布 本次变更如下： 修改查询播放画像接口的参考示例。 2022-03-25 第二十八次正式发布 本次变更如下： 修改直播转码模板删除成功的状态码为200。 2022-03-01 第二十七次正式发布 本次变更如下： 调整查询直播中的流信息接口的用户和API流量限制，用户流量限制由4000次/分钟变更为1000次/分钟，API流量限制由8000次/分钟变更为2000次/分钟。 调整禁推恢复接口的用户和API流量限制，用户流量限制由4000次/分钟变更为3000次/分钟，API流量限制由8000次/分钟变更为6000次/分钟。 调整查询禁止直播推流列表接口的用户和API流量限制，用户流量限制由300次/分钟变更为3000次/分钟，API流量限制由3000次/分钟变更为6000次/分钟。 调整禁止直播推流和修改禁推属性接口的API流量限制，由8000次/分钟变更为12000次/分钟。 2022-02-28 第二十六次正式发布 本次变更如下： 删除查询直播转码任务数接口。 调整查询播放带宽趋势接口的用户流量限制，由300次/分钟变更为500次/分钟。 2022-02-22 第二十五次正式发布 本次变更如下： 流监控中增加查询流监控数据接口。 2022-01-26 第二十四次正式发布 本次变更如下： 修改录制管理接口组，删除“PLAN_RECORD”、“ON_DEMAND_RECORD”相关参数和说明。 修改录制回调管理接口组，删除“on_demand_callback_url”相关参数和说明。 数据统计分析中增加查询直播转码任务数接口和查询直播各区域指标分布接口。 2021-12-21 第二十三次正式发布 本次变更如下： 修改流管理接口组和转码模板管理接口组中“domain”参数的描述，变更为推流域名。 2021-12-16 第二十二次正式发布 本次变更如下： 修改创建录制规则接口的“default_record_config”参数为必填。 修改查询录制回调配置列表和查询录制规则列表接口的“offset”、“limit”参数的描述。 2021-11-26 第二十一次正式发布 本次变更如下： 查询录制用量接口，增加“publish_domain”参数。 查询推流帧率数据接口，增加返回的帧率数据列表粒度为1秒钟的描述。 查询推流码率数据接口，增加返回的码率数据列表粒度为1秒钟的描述。 查询历史推流列表接口，删除最大查询周期1个月的描述。 2021-10-27 第二十次正式发布 本次变更如下： 查询推流帧率数据和查询推流码率数据接口修改“data_list”参数描述，增加帧率和码率单位。 2021-09-26 第十九次正式发布 本次变更如下： 修改查询播放画像信息接口，增加约束描述，不统计协议为HLS的播放时长（play_duration）信息。 修改查询转码用量接口，增加“stream”参数。 2021-09-10 第十八次正式发布 本次变更如下： 录制管理中增加提交录制控制命令接口。 修改查询直播中的流信息接口，增加“video_frame_rate”、“audio_frame_rate”等参数。 2021-08-12 第十七次正式发布 本次变更如下： 查询播放带宽趋势接口和查询观众趋势接口增加“country”参数。 新增“国家名称缩写”章节内容。 2021-06-02 第十六次正式发布 本次变更如下： 创建录制规则接口修改“record_format”字段的格式，设置格式时必须使用大写字母。 2021-03-05 第十五次正式发布 本次变更如下： 上线录制管理接口组和录制回调管理接口组。 2021-01-28 第十四次正式发布 本次变更如下： 上线域名管理接口组和日志管理接口。 2021-01-19 第十三次正式发布 本次变更如下： 流管理中增加查询直播中的流信息接口。 2020-11-13 第十二次正式发布 本次变更如下： 数据统计分析中增加查询转码用量接口、查询录制用量接口和查询截图用量接口。 2020-09-17 第十一次正式发布 本次变更如下： 禁止直播推流接口修改“resume_time”字段的取值范围，默认值为7天，最大支持90天。 2020-08-25 第十次正式发布 本次变更如下： 数据统计分析中增加查询上行带宽数据接口、查询域名维度推流路数接口和查询历史推流列表接口。 2020-08-12 第九次正式发布 本次变更如下： 数据统计分析中增加查询直播拉流HTTP状态码接口。 2020-08-05 第八次正式发布 本次变更如下： 上线数据统计分析接口组和流监控接口组。 2020-07-30 第七次正式发布 本次变更如下： 增两个API应用示例，示例2：创建录制配置和示例3：禁止直播推流。 2020-05-20 第六次正式发布 本次变更如下： 所有接口增加“调试”内容，支持跳转到 API Explorer 进行接口调试。 2020-04-10 第五次正式发布 本次变更如下： 下线“查询直播推流列表”接口，后续将上线相关新接口。 2019-11-14 第四次正式发布 本次变更如下： 上线新版“查询直播推流列表”接口。 2019-07-27 第三次正式发布 本次变更如下： 修改转码模板管理接口，增加“iFrameInterval”、“GOP”等参数。 2019-06-27 第二次正式发布 本次变更如下： 增加应用示例章节，以具体接口为例，介绍如何调用直播API。 修改API参考文档，增加使用前必读和如何调用API章节。 2018-11-20 第一次正式商用发布。

请求示例 修改录制回调配置。 PUT https://{endpoint}/v1/{project_id}/record/callback/e89b76xxxxxx3425ui80af501cdxxxxxx { "publish_domain" : "publish.example.com", "app" : "**", "notify_callback_url" : "https://mycallback.com.cn/record_notify", "notify_event_subscription" : [ "RECORD_FILE_COMPLETE" ] }

请求参数 表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名称。如果需要匹配任意应用则需填写*。录制规则匹配的时候，优先精确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 加密类型，包含如下取值 HMA CS HA256 MD5 不填写时，取默认值HMACSHA256 key 否 String 回调密钥，主要用于鉴权。为了保护用户数据信息安全，建议填写。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表5 响应Body参数 参数 参数类型 描述 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 加密类型，包含如下取值 HMACSHA256 MD5 create_time String 创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 update_time String 修改时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 状态码： 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 查询直播中的流信息数据成功 { "total_page" : 1, "total_num" : 10, "offset" : 0, "limit" : 10, "request_id" : "56b9f4dc-b282-48e0-a1a9-c50ffb06b687", "streams" : [ { "publish_domain" : "push.example.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" }

请求参数 表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_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不能缺省

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 domain 是 String 域名 is_ipv6 否 Boolean IPV6开关配置，默认关闭，true为开启，false为关闭

请求参数 表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 直播播放日志获取成功 { "total" : 1, "domain" : "play.example.com", "logs" : [ { "name" : "play.example.com_20200304160000.log.gz", "url" : "https://xxxxxxxxx/play.example.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" }

响应示例 状态码： 200 查询成功。 注意：不返回certificate_key内容，其值为空 { "certificate_format" : "PEM", "certificate" : "", "certificate_key" : "", "force_redirect" : false } 状态码： 400 参数校验不通过。如：传入domain为空、证书校验不通过。 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } 状态码： 401 未授权访问接口 { "error_code" : "LIVE.100011003", "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions" } 状态码： 404 访问资源不存在，如：域名不存在。 { "error_code" : "LIVE.103011019", "error_msg" : "The resource to access is not exists" } 状态码： 500 服务内部错误 { "error_code" : "LIVE.100011005", "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve" }

请求参数 表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参数 参数 参数类型 描述 certificate_format String 证书格式，默认为PEM，当前只支持PEM格式 certificate String 证书内容，若在tls_certificate有传值，则此字段无效 certificate_key String 私钥内容，若在tls_certificate有传值，则此字段无效 force_redirect Boolean 是否开启重定向，默认false gm_certificate GmCertificateInfo object 国密证书配置内容， 国际、国密需要至少配置一个证书 tls_certificate TlsCertificateInfo object 国密证书配置内容。需要配置一个国际证书，或者一个国密证书，或者同时配置一个国密证书和一个国际证书。若配置了当前字段，则忽略外层国际证书的同级配置字段“certificate”和“certificate_key”。 表5 GmCertificateInfo 参数 参数类型 描述 source String 证书来源， 可选, scm: 云证书管理服务 ，user：默认，用户自有 cert_name String SCM证书名， 可选 cert_id String SCM证书ID, 证书来源为scm时必选 sign_certificate String 国密签名证书内容 sign_certificate_key String 国密签名私钥内容 enc_certificate String 国密加密证书内容 enc_certificate_key String 国密加密私钥内容 表6 TlsCertificateInfo 参数 参数类型 描述 source String 证书来源， 可选, scm: 云证书管理 服务，user：默认，用户自有 cert_name String SCM证书名， 证书来源为scm时可选 cert_id String SCM证书ID, 证书来源为scm时必选 certificate String 证书内容，证书来源为user时必选 certificate_key String 私钥内容，证书来源为user时必选 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 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 错误描述

请求参数 表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信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 查询结果的总元素数量 traffic_info Array of TrafficInfo objects 流量信息 表5 TrafficInfo 参数 参数类型 描述 traffic Integer 采样周期内的总流量，单位：byte timestamp String 流量数据采样周期起始时刻，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询直播加速的流量数据成功 { "total" : 1, "traffic_info" : [ { "traffic" : 1024, "timestamp" : "2018-05-19T21:10:15Z" } ] } 状态码： 400 查询直播加速的流量数据失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }

URI GET /v1/{project_id}/stream/traffic 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 否 String 播放域名，不指定域名表示查询租户所有域名汇总流量 start_time 否 String 查询起始时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ end_time 否 String 查询结束时间，UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。 start_time与end_time均不存在时，服务端从最近一个统计周期的数据里查询。 start_time存在、end_time不存在时，end_time取当前时间。 start_time不存在、end_time存在时，请求非法。 只能查询最近三个月内的数据，start_time和end_time的跨度不能大于30天。 step 否 Integer 统计周期，单位：分钟

响应示例 状态码： 400 参数校验不通过 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } 状态码： 401 未授权访问接口 { "error_code" : "LIVE.100011003", "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions" } 状态码： 404 访问资源不存在，如：域名不存在。 { "error_code" : "LIVE.103011019", "error_msg" : "The resource to access is not exists" } 状态码： 500 服务内部错误 { "error_code" : "LIVE.100011005", "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve" }

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应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信息。

请求示例 修改直播转码模板，应用名称为live，转码质量为SD，转码编码格式为H264，宽为1920像素，高为1080像素。 PUT https://{endpoint}/v1/{project_id}/template/transcodings { "domain" : "play.example.com", "app_name" : "live", "quality_info" : [ { "quality" : "lsd", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 }, { "quality" : "userdefine", "templateName" : "yourTemplateName", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 } ] }

请求参数 表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 推流域名 app_name 是 String 应用名称 trans_type 否 String 转码流触发模式。 play：拉流触发转码。 publish：推流触发转码。 默认为play quality_info 是 Array of QualityInfo objects 视频质量信息 表4 QualityInfo 参数 是否必选 参数类型 描述 quality 是 String 包含如下取值： lud：超高清，系统缺省名称。 lhd：高清，系统缺省名称。 lsd：标清，系统缺省名称。 lld：流畅，系统缺省名称。 userdefine：视频质量自定义。填写userdefine时，templateName字段不能为空。 templateName 否 String 自定义模板名称。 若需要自定义模板名称，请将quality参数设置为userdefine。 多个自定义模板名称之间不能重复。 自定义模板名称不能与其他模板的quality参数重复。 若quality不为userdefine，请勿填写此字段。 PVC 否 String 是否使用窄带高清转码。 注意：该字段已不再维护，建议使用hdlb。 包含如下取值： off：不启用。 on：启用。 默认值：off。 hdlb 否 String 是否启用高清低码，较PVC相比画质增强。 提示：使用hdlb字段开启高清低码时，PVC字段不生效。 包含如下取值： off：不开启高清低码。 on：开启高清低码。 默认值：off。 codec 否 String 视频编码格式。 包含如下取值： H264：使用H.264。 H265：使用H.265。 默认为H264。 width 否 Integer 视频的长边。其中，横屏为宽，即长边，竖屏为高。单位：像素。 包含如下取值： codec的取值为H264时，width建议取值范围为[32,3840]，且必须为2整数倍。 codec的取值为H265时，width建议取值范围为[320,3840]，且必须为2的整数倍。 注意：width和height全为0时，输出的分辨率和源保持一致；width和height只有一个为0时，输出的分辨率按非0项的比例进行缩放。 默认值：0。 height 否 Integer 视频的短边。其中，横屏为宽，竖屏为高，即短边。单位：像素。 包含如下取值： codec的取值为H264时，height建议取值范围为[32,2160]，且必须为2的整数倍。 codec的取值为H265时，height建议取值范围为[240,2160]，且必须为2的整数倍。 注意：width和height全为0时，输出的分辨率和源保持一致；width和height只有一个为0时，输出的分辨率按非0项的比例进行缩放。 默认值：0。 bitrate 是 Integer 转码视频的码率。 单位：Kbps 取值范围：40-30000。 video_frame_rate 否 Integer 转码视频帧率。 单位：fps 取值范围：0-60，0表示保持帧率不变。 默认值：0。 protocol 否 String 转码输出支持的协议类型。默认为RTMP。当前只支持RTMP。 包含如下取值： RTMP iFrameInterval 否 Integer 最大I帧间隔。 单位：帧数 取值范围：[0, 500]，默认值：50。 注意：若希望通过iFrameInterval设置i帧间隔，请将gop设为0，或不传gop参数。 gop 否 Integer 按时间设置I帧间隔。 单位：秒 取值范围：[0,10]，默认值：2。 注意：gop不为0时，则以gop设置i帧间隔，iFrameInterval字段不生效。 bitrate_adaptive 否 String 自适应码率参数。 包含如下取值： off：关闭码率自适应，目标码率按设定的码率输出。 minimum：目标码率按设定码率和源文件码率最小值输出（即码率不上扬）。 adaptive：目标码率按源文件码率自适应输出。 默认值：off。 i_frame_policy 否 String 编码输出I帧策略。 包含如下取值： auto：I帧按设置的gop时长输出。 strictSync：编码输出I帧完全和源保持一致（源是I帧则编码输出I帧，源不是I帧则编码非I帧），设置该参数后gop时长设置无效。 默认值：auto。 注意：多码率场景下建议开启I帧随源，保障多码率I帧对齐。

请求参数 表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 直播推流域名 app_name 是 String 应用名称 auth_key 否 String 回调鉴权密钥值 长度范围：[32-128] 若需要使用回调鉴权功能，请配置鉴权密钥，否则，留空即可。 time_interval 是 Integer 截图频率 取值范围：[5-3600] 单位：秒 object_write_mode 是 Integer 在OBS桶存储截图的方式： 0：全保存模式，截图文件名中含时间戳，每条流的所有截图文件均会保存在存储对象里。示例：snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg 1：覆盖模式，截图文件名不含时间戳，每条流只保存最新的截图文件，新的截图文件会覆盖原来的截图文件。示例：snapshot/{domain}/{app_name}/{stream_name}.jpg obs_location 是 ObsFileAddr object OBS存储位置信息 call_back_enable 否 String 是否启用回调通知 on：启用。 off：不启用。 call_back_url 否 String 通知服务器地址，必须是合法的URL且携带协议，协议支持http和https。截图完成后直播服务会向此地址推送截图状态信息。 表4 ObsFileAddr 参数 是否必选 参数类型 描述 bucket 是 String OBS的bucket名称 location 是 String OBS Bucket所在的区域，且必须保持与使用的直播服务区域保持一致。 object 是 String OBS对象路径，遵守OSS Object定义 当用于指示input时，需要指定到具体对象 当用于指示output时，只需指定到截图结果期望存放的路径

请求示例 创建直播截图配置。 POST https://{endpoint}/v1/{project_id}/stream/snapshot { "domain" : "play.example.huawei.com", "app_name" : "live", "time_interval" : 5, "object_write_mode" : 1, "obs_location" : { "bucket" : "cls-test", "location" : "region1", "object" : "/ffff/aa/" } }

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