华为云用户手册

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用创建的用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型

约束与限制 视频直播 服务对服务端API设置了调用次数限制，避免出现短时间内重复调用API，服务中断的情况。 表2 API流控限制 接口分类 接口名称 用户流量限制 API流量限制 域名 管理 创建直播域名 查询直播域名 300次/分钟 3000次/分钟 删除直播域名 修改直播域名 域名映射 删除直播域名映射关系 配置域名IPV6开关 修改域名HLS配置 查询域名HLS配置 100次/分钟 1000次/分钟 查询IP归属信息 5次/秒 5次/秒 修改播放域名延时配置 修改直播拉流回源配置 30次/分钟 100次/分钟 查询播放域名延时配置 查询直播拉流回源配置 30次/分钟 300次/分钟 转码模板管理 创建直播转码模板 删除直播转码模板 修改直播转码模板 查询直播转码模板 100次/分钟 1000次/分钟 流管理 禁止直播推流 修改禁推属性 4000次/分钟 12000次/分钟 查询禁止直播推流列表 禁推恢复 3000次/分钟 6000次/分钟 查询直播中的流信息 1000次/分钟 2000次/分钟 通知管理 新增、修改直播推流通知配置 查询直播推流通知配置 删除直播推流通知配置 300次/分钟 3000次/分钟 鉴权管理 设置Referer防盗链黑白名单 删除Referer防盗链黑白名单 查询Referer防盗链黑白名单 查询IP黑/白名单 修改IP黑/白名单 生成URL鉴权串 300次/分钟 3000次/分钟 查询播放域名的地域限制列表 30次/分钟 300次/分钟 修改播放域名的地域限制配置 30次/分钟 100次/分钟 查询指定域名的Key防盗链配置 更新指定域名的Key防盗链配置 删除指定域名的Key防盗链配置 150次/分钟 300次/分钟 截图管理 创建直播截图配置 修改直播截图配置 查询直播截图配置 删除直播截图配置 150次/分钟 300次/分钟 日志管理 获取直播播放日志 300次/分钟 3000次/分钟 录制管理 创建录制规则 查询录制规则列表 修改录制规则 删除录制规则 查询录制规则配置 提交录制控制命令 300次/分钟 3000次/分钟 创建录制视频索引文件 1200次/分钟 3000次/分钟 录制回调管理 创建录制回调配置 查询录制回调配置列表 修改录制回调配置 查询录制回调配置 删除录制回调配置 300次/分钟 300次/分钟 HTTPS证书管理 修改指定域名的HTTPS证书配置 查询指定域名的HTTPS证书配置 删除指定域名的HTTPS证书配置 150次/分钟 300次/分钟 OBS桶管理 OBS桶授权及取消授权 150次/分钟 300次/分钟 数据统计分析 查询播放带宽趋势接口 100次/秒 600次/秒 查询播放流量趋势接口 20次/秒 200次/秒 查询观众趋势接口 20次/秒 200次/秒 数据统计分析 查询播放带宽峰值接口 20次/秒 200次/秒 查询播放流量汇总接口 20次/秒 300次/秒 查询直播拉流HTTP状态码接口 30次/秒 300次/秒 查询转码用量接口 20次/秒 200次/秒 查询录制用量接口 20次/秒 200次/秒 查询截图用量接口 20次/秒 200次/秒 查询上行带宽数据接口 20次/秒 300次/秒 查询域名维度推流路数接口 20次/秒 300次/秒 查询历史推流列表接口 30次/秒 300次/秒 查询播放画像信息接口 10次/秒 100次/秒 查询直播各区域指标分布接口 50次/秒 150次/秒 数据统计分析 查询播放域名下的流数据 20次/秒 50次/秒 流监控 查询推流帧率数据接口 10次/秒 200次/秒 查询推流码率数据接口 10次/秒 200次/秒 查询推流监控数据接口 10次/秒 200次/秒 查询CDN上行推流质量数据接口 30次/秒 300次/秒

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，Live的终端节点如表1所示。您也可以从地区和终端节点中查询服务的终端节点。 表1 Live的终端节点 区域名称 区域 终端节点（Endpoint） 华北-北京一 cn-north-1 live.cn-north-1.myhuaweicloud.com 华北-北京四 cn-north-4 live.cn-north-4.myhuaweicloud.com 亚太-新加坡 ap-southeast-3 live.ap-southeast-3.myhuaweicloud.com

请求参数 表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 查询录制配置成功 { "id" : "0f78cc406baad9ca3e1fd76656dea1ab", "publish_domain" : "publish.example.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信息。

请求示例 修改直播拉流回源配置，仅支持RTMP、FLV域名。 PUT https://{endpoint}/v1/{project_id}/domain/pull-sources { "play_domain" : "pull.example.test.com", "source_type" : "domain", "sources" : [ "example1.test.com", "example2.test.com" ], "scheme" : "http", "additional_args" : { "key1" : "value1", "key2" : "value2" } }

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

请求示例 修改指定域名的https证书配置。 PUT https://{endpoint}/v1/{project_id}/guard/https-cert?domain=play.example.huawei.com { "certificate_format" : "PEM", "certificate" : "your cert", "certificate_key" : "your cert key", "force_redirect" : true }

请求参数 表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参数 参数 是否必选 参数类型 描述 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时必选

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

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

URI DELETE /v1/{project_id}/stream/blocks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名 app_name 是 String 应用名称 stream_name 是 String 流名称（不为*）

请求示例 修改录制规则。 PUT https://{endpoint}/v1/{project_id}/record/rule/e89b76xxxxxx3425ui80af501cdxxxxxx { "publish_domain" : "publish.example.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

修订记录 表1 修订记录 发布日期 修改说明 2025-05-30 第五十二次发布： 本次变更如下： 新增直播水印管理接口组。 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 第一次正式商用发布。

请求参数 表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 查询直播截图配置操作成功 { "total" : 2, "offset" : 0, "limit" : 10, "snapshot_config_list" : [ { "domain" : "testsnapshot.huawei.com", "app_name" : "live", "time_interval" : 5, "object_write_mode" : 1, "obs_location" : { "bucket" : "obs-d95a", "location" : "region1", "object" : "test1/" } }, { "domain" : "testsnapshot.huawei.com", "app_name" : "src", "time_interval" : 5, "object_write_mode" : 1, "obs_location" : { "bucket" : "obs-d95a", "location" : "region1", "object" : "test2/" } } ] } 状态码：400 查询直播截图配置操作失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }

URI GET /v1/{project_id}/stream/snapshot 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 域名 app_name 否 String 应用名称 limit 否 Integer 每页记录数 取值范围[1,100] 默认值：10 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0

请求参数 表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 总条目数 snapshot_config_list Array of LiveSnapshotConfig objects 截图配置 limit Integer 每页记录数 offset Integer 偏移量 表5 LiveSnapshotConfig 参数 参数类型 描述 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。截图完成后直播服务会向此地址推送截图状态信息。 image_object_format String 截图存储文件命名规则， 仅支持jpg格式 包含 '{{.obs_object}}' OBS存储路径，即obs_location.object的值 '{{.domain}}' 域名 '{{.app}}' 应用名 '{{.stream}}' 流名 其中实时截图模式下 '{{.unix_time}}' 时间戳，秒 '{{.unix_time_milli}}' 时间戳，毫秒 '{{.fmt_time_utc}}' 格式化UTC时间, 格式：YYYYMMDDhhmmss, 如20060102070405 '{{.fmt_time_local}}' 格式化本地时间, 格式：YYYYMMDDhhmmss，如20060102150405 必选一个时间类型模板 image_access_protocol String 截图存储文件访问协议， 仅支持http、https格式 image_access_domain String 截图存储文件访问域名 表6 ObsFileAddr 参数 参数类型 描述 bucket String OBS的bucket名称 location String OBS Bucket所在的区域，且必须保持与使用的直播服务区域保持一致。 object String OBS对象路径，遵守OSS Object定义 当用于指示input时，需要指定到具体对象 当用于指示output时，只需指定到截图结果期望存放的路径 状态码：400 表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信息。

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