华为云用户手册

请求示例 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}

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 直播域名修改成功 { "domain" : "play.example.huawei.com", "domain_type" : "pull", "domain_cname" : "play.example.huawei.com.c.cdnhwc3.com", "region" : "region1", "status" : "off", "create_time" : "2020-01-19T02:57:00Z"} 状态码： 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信息。 表4 请求Body参数 参数 是否必选 参数类型 描述 certificate_format 否 String 证书格式，默认为PEM，当前只支持PEM格式 certificate 是 String 证书内容 certificate_key 是 String 私钥内容 force_redirect 否 Boolean 是否开启重定向，默认false

请求参数 表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 直播域名，不允许修改 status 否 String 直播域名状态，通过修改此字段，实现域名的启用和停用；域名处于“配置中”状态时，不允许对该域名执行启停操作 enterprise_project_id 否 String 企业项目ID

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 domain String 直播域名 domain_type String 域名类型 pull：播放域名 push：推流域名 domain_cname String 直播域名的CNAME region String 直播所属直播中心 status String 直播域名的状态 create_time String 域名创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间 status_describe String 状态描述 service_area String 域名加速区域 mainland_china：中国大陆 outside_mainland_china：中国大陆境外 global：全球加速 enterprise_project_id String 企业项目ID 状态码： 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信息，与路径参数中的项目ID相同。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 bitrate_info_list Array of V2BitrateInfo objects 用量详情。 表6 V2BitrateInfo 参数 参数类型 描述 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 integers 码率信息列表，单位为Kbps。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 处理成功返回。 { "bitrate_info_list" : [ { "publish_domain" : "example.xxx.com", "app" : "app", "stream" : "pull_stream", "start_time" : "2020-06-04T07:00:00Z", "end_time" : "2020-06-05T07:00:00Z", "data_list" : [ 100, 200 ] } ]} 状态码： 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domain"}

URI GET /v2/{project_id}/stats/stream/bitrate 表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天，最大查询周期1个月。 若参数为空，默认查询最近1小时数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 若参数为空，默认为当前时间。结束时间需大于起始时间。

响应示例 状态码： 200 查询录制配置成功 { "total" : 1, "record_config" : [ { "id" : "42810594c2fc9xxxx36b7784c76a06e8", "publish_domain" : "publish.xxx.com", "app" : "live", "stream" : "*", "record_type" : "CONTINUOUS_RECORD", "default_record_config" : { "record_format" : [ "HLS" ], "obs_addr" : { "bucket" : "mybucket", "location" : "region1", "object" : "record/" }, "hls_config" : { "record_cycle" : 900, "record_prefix" : "record-publish_domain-app-stream-file_start_time_unix/record-publish_domain-app-stream-file_start_time_unix", "record_ts_prefix" : "{stream}-{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}", "record_slice_duration" : 10, "record_max_duration_to_merge_file" : 60 } } } ]} 状态码： 400 参数错误 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal"}

URI GET /v1/{project_id}/record/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domain 否 String 直播推流域名 app 否 String 流应用名称 stream 否 String 流名称 record_type 否 String 录制类型，如果不填写则查询所有录制类型，包括：CONTINUOUS_RECORD，COMMAND_RECORD。默认CONTINUOUS_RECORD。 CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，即触发录制。 COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过命令控制该流的录制开始和结束。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0 limit 否 Integer 每页记录数，取值范围[1,100]，默认值10

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表5 响应Body参数 参数 参数类型 描述 total Integer 查询结果的总元素数量 record_config Array of RecordRule objects 录制配置数组 表6 RecordRule 参数 参数类型 描述 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时间。 在查询的时候返回 表7 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配置规则 表8 RecordObsFileAddr 参数 参数类型 描述 bucket String OBS的bucket名称 location String OBS Bucket所在RegionID object String OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 表9 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天内的前一个文件保存。 表10 FLVRecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大12小时（43200秒）。 如果为0，则使用默认值6小时（21600秒）。 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 表11 MP4RecordConfig 参数 参数类型 描述 record_cycle Integer 周期录制时长 单位：秒，最小1分钟（60秒），最大12小时（43200秒）。 如果为0，则使用默认值6小时（21600秒）。 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 表12 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） 表13 响应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 处理成功返回。 { "publish_domain" : "example.xxx.com", "app" : "app", "stream" : "pull_stream", "video_framerate" : [ { "start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 21, 22 ] }, { "start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 13, 34, 21 ] } ], "video_bitrate" : [ { "start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 1326, 1268, 775 ] }, { "start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:07Z", "data_list" : [ 1021, 2022 ] } ], "audio_framerate" : [ { "start_time" : "2022-02-04T07:00:00Z", "end_time" : "2022-02-04T07:00:02Z", "data_list" : [ 10, 17 ] }, { "start_time" : "2022-02-04T07:00:05Z", "end_time" : "2022-02-04T07:00:06Z", "data_list" : [ 31, 33 ] } ]} 状态码： 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_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相同。

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

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 publish_domain String 推流域名 app String 应用名 stream String 流名 video_framerate Array of StreamDetail objects 展示流视频帧率情况，帧率单位为fps。 如果出现断流则会出现多个时间段流信息，如： "video_framerate": [ { "start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [ 21, 22 ] }, { "start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:07Z", "data_list": [ 13, 34, 21 ] } ] video_bitrate Array of StreamDetail objects 展示流视频码率情况，码率单位为Kbps。 如果出现断流则会出现多个时间段流信息，如： "video_bitrate": [ { "start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [ 1326, 1268, 775 ] }, { "start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:07Z", "data_list": [ 1021, 2022 ] } ] audio_framerate Array of StreamDetail objects 展示流音频帧率情况，帧率单位为fps。 如果出现断流则会出现多个时间段流信息，如： "audio_framerate": [ { "start_time": "2022-02-04T07:00:00Z", "end_time": "2022-02-04T07:00:02Z", "data_list": [ 10, 17 ] }, { "start_time": "2022-02-04T07:00:05Z", "end_time": "2022-02-04T07:00:06Z", "data_list": [ 31, 33 ] } ] 表6 StreamDetail 参数 参数类型 描述 start_time String 采样开始时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 end_time String 采样结束时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ。 data_list Array of integers 流监控数据列表。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 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 integers 帧率信息列表，单位为fps。 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 处理成功返回。 { "framerate_info_list" : [ { "publish_domain" : "example.xxx.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天，最大查询周期1个月。 若参数为空，默认查询最近1小时数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。 若参数为空，默认为当前时间。结束时间需大于起始时间。

请求参数 表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 /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

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

请求参数 表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 LiveSnapshotConfig object 截图配置 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：实时截图，以时间戳命名截图文件，保存所有截图文件到OBS桶。例：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。截图完成后直播服务会向此地址推送截图状态信息。 表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信息, 与路径参数中的项目ID相同。

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 transcode_data_list Array of TranscodeData objects 采样数据列表。 summary_list Array of TranscodeSummary objects 指定时间区间内各转码规格转码时长总和。 表6 TranscodeData 参数 参数类型 描述 spec_list Array of TranscodeSpec objects 每个采样时间中的转码时长信息。 time String 采样时间。日期格式按照ISO8601表示法，并使用UTC时间。 格式为：YYYY-MM-DDThh:mm:ssZ 。 表7 TranscodeSpec 参数 参数类型 描述 type String 转码规格，格式是“编码格式_分辨率档位”（未开启高清低码）和“编码格式_PVC_分辨率档位”（开启高清低码）。其中编码格式包括H264、H265，分辨率档位包括：4K（3840 x 2160）及以下，2K（2560 x 1440）及以下，FHD（1920 x 1080）及以下，HD（1280 x 720）及以下，SD（640 x 480）及以下。 value Double 采样时间点转码时长，单位为分钟，保留两位小数。 表8 TranscodeSummary 参数 参数类型 描述 type String 转码规格，格式是“编码格式_分辨率档位”（未开启高清低码）和“编码格式_PVC_分辨率档位”（开启高清低码）。其中编码格式包括H264、H265，分辨率档位包括：4K（3840 x 2160）及以下，2K（2560 x 1440）及以下，FHD（1920 x 1080）及以下，HD（1280 x 720）及以下，SD（640 x 480）及以下。 value Double 总转码时长，单位为分钟，保留两位小数。 状态码： 400 表9 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 处理成功返回。 { "transcode_data_list" : [ { "time" : "2020-08-18T07:00:00Z", "spec_list" : [ { "type" : "H265_PVC_SD", "value" : 256.23 }, { "type" : "H265_PVC_HD", "value" : 128.41 } ] }, { "time" : "2020-08-18T08:00:00Z", "spec_list" : [ { "type" : "H265_PVC_SD", "value" : 52.35 }, { "type" : "H265_PVC_HD", "value" : 136.32 } ] } ], "summary_list" : [ { "type" : "H265_PVC_SD", "value" : 308.58 }, { "type" : "H265_PVC_HD", "value" : 264.73 } ]} 状态码： 400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_domain"}

URI GET /v2/{project_id}/stats/transcode 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domain 否 String 推流域名。 stream 否 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。若参数为空，默认为当前时间。结束时间需大于起始时间。