华为云用户手册

  • 响应示例 状态码: 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。若参数为空,默认为当前时间。结束时间需大于起始时间。
  • 响应参数 状态码: 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 表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 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "snapshot_list" : [ { "time" : "2020-08-18T07:00:00Z", "count" : 25 }, { "time" : "2020-08-18T08:00:00Z", "count" : 50 } ], "total" : 75} 状态码: 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/snapshot 表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。若参数为空,默认为当前时间。结束时间需大于起始时间。
  • URI GET /v2/{project_id}/stats/up-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 流名 data Array of UpStreamDetail objects 推流质量数据 表6 UpStreamDetail 参数 参数类型 描述 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 fps Long 帧率。 单位fps。 rate Long 码率。 单位Kbps。 delay Long 时延。 单位ms。 gop_duration Long 最近一次gop的时长。 单位ms。 last_video_pts Long 视频DTS。 单位ms。 last_audio_pts Long 音频DTS。 单位ms。 last_video_audio_pts_diff Long 音视频DTS差值。 单位ms。 状态码: 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 处理成功返回。 { "publish_domain" : "push-rtmp-l10-sg01.tiktokcdn.com", "app" : "stage", "stream" : "stream-7159441965564594945", "data" : [ { "fps" : 29, "rate" : 8191, "delay" : 225, "gop_duration" : 1999, "last_video_pts" : 1224054, "last_audio_pts" : 1224054, "last_video_audio_pts_diff" : 0, "time" : "2020-04-23T07:00:00Z" }, { "fps" : 28, "rate" : 184, "delay" : 0, "gop_duration" : 0, "last_video_pts" : 10135133, "last_audio_pts" : 10135125, "last_video_audio_pts_diff" : 8, "time" : "2020-04-23T07:00:00Z" } ]} 状态码: 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: publish_domain"}
  • 响应示例 状态码: 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"}
  • 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参数 参数 参数类型 描述 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相同。
  • 请求参数 表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 V2UserData objects 观众趋势列表。 表6 V2UserData 参数 参数类型 描述 value 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 错误描述。
  • 响应示例 状态码: 200 处理成功返回。 { "data_list" : [ { "value" : 50, "time" : "2020-06-04T07:00:00Z" }, { "value" : 60, "time" : "2020-06-04T07:01:00Z" } ]} 状态码: 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: play_domain"}
  • URI GET /v2/{project_id}/stats/user 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domain 是 String 播放域名。 app 否 String app名。 stream 否 String 流名。 isp 否 Array 运营商列表,取值如下: CMCC :移动 CTCC : 电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 country 否 Array 国家列表。具体取值请参考国家名称缩写,不填写查询所有国家。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 protocol 否 String 请求协议 interval 否 Integer 查询数据的时间粒度,支持60(默认值), 300秒。不传值时,使用默认值60秒。 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日后的数据生效。
  • URI POST /v1/{project_id}/record/control 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 操作行为。 (在停止录制命令下发之后,再次对相同流下发开始录制命令的时间间隔必须在10秒以上) 取值如下: START:对指定流开始录制,必须在直播流已经推送情况下才能正常启动,使用此命令启动录制的直播流如果发生了断流且超出断流时长,就会停止录制,并且重新推流后不会自动启动录制。 STOP:对指定流停止录制。
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 publish_domain 是 String 直播推流域名 app 是 String 应用名 stream 是 String 待启动或停止录制的流名
  • 响应参数 状态码: 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 状态码: 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 错误描述 状态码: 404 表8 响应Header参数 参数 参数类型 描述 X-request-id String 此字段携带请求ID号,以便任务跟踪。 格式为 request_id-timestamp-hostname(request_id在服务器端生成UUID, timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Number 查询结果的总数量 domain_info Array of DecoupledLiveDomainInfo objects 直播域名列表 表5 DecoupledLiveDomainInfo 参数 参数类型 描述 domain String 直播域名 domain_type String 域名类型 vendor String CDN厂商 region String 直播所属直播中心 domain_cname String 直播域名的CNAME status String 直播域名的状态 related_domain String 播放域名关联的推流域名(只有domain_type为pull的时候有效) 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 is_ipv6 Boolean IPV6开关是否开启,默认关闭,true为开启;false或空为关闭 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 直播域名查询成功 { "total" : 2, "domain_info" : [ { "domain" : "play.example.huawei.com", "domain_type" : "pull", "vendor" : "uCDN", "domain_cname" : "play.example.huawei.com.c.cdnhwc3.com", "region" : "region1", "status" : "on", "related_domain" : "publish.example.huawei.com", "create_time" : "2020-01-19T02:57:00Z" }, { "domain" : "publish.example.huawei.com", "domain_type" : "push", "vendor" : "uCDN", "domain_cname" : "publish.example.huawei.com.c.cdnhwc3.com", "region" : "region1", "status" : "on", "related_domain" : "", "create_time" : "2020-01-19T02:58:00Z" } ]} 状态码: 404 直播域名查询失败 { "error_code" : "LIVE.103011019", "error_msg" : "Request Illegal"}
  • URI GET /v1/{project_id}/domain 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 否 String 直播域名,如果不设置此字段,则返回租户所有的域名信息 enterprise_project_id 否 String 企业项目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信息。
  • 响应示例 状态码: 200 查询成功 { "key" : "IbBIzklRGCyMEd18oPV9sxAuuwNIzT81", "auth_type" : "d_sha256", "timeout" : 3600} 状态码: 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"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 key String 防盗链Key值,由32个字符组成,支持大写字母、小写字母、数字。不可为纯数字或纯字母。 auth_type String 计算鉴权串的方式: d_sha256:鉴权方式D,采用HMAC-SHA256算法,建议优先选择此方式; c_aes:鉴权方式C,采用对称加密算法; b_md5:鉴权方式B,采用MD5信息摘要算法; a_md5:鉴权方式A,采用MD5信息摘要算法。 说明: 鉴权方式ABC存在安全风险,鉴权方式D拥有更高的安全性,建议您优先使用鉴权方式D。 timeout Integer URL鉴权信息的超时时长 取值范围:[60,2592000],即1分钟-30天 单位:秒 鉴权信息中携带的请求时间与直播服务收到请求时的时间的最大差值,用于检查直播推流URL或者直播播放URL是否已过期 状态码: 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 错误描述
  • 请求参数 表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 证书内容 certificate_key String 私钥内容 force_redirect Boolean 是否开启重定向,默认false 状态码: 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 错误描述
共100000条