云服务器内容精选

  • 地区/国家代码对照表 计费大区 地区/国家 代码 AP1 亚太1区 中国香港 HK 中国澳门 MO 中国台湾 TW 日本 JP 韩国 KR AP2 亚太2区 泰国 TH 印度尼西亚 ID 菲律宾 PH 马来西亚 MY 新加坡 SG 柬埔寨 KH 老挝 LA 越南 VN AP3 亚太3区 印度 IN 澳大利亚 AU 孟加拉 BD MEAA 中东非洲 沙特阿拉伯 SA 伊拉克 IQ 阿联酋 AE 科威特 KW 卡塔尔 QA 阿曼 OM 巴林 BH 阿塞拜疆 AZ 土耳其 TR 南非 ZA 埃及 EG 加纳 GH 肯尼亚 KE 尼日利亚 NG SA 南美 阿根廷 AR 巴西 BR 智利 CL 哥伦比亚 CO 墨西哥 MX 秘鲁 PE EU 欧洲 哈萨克斯坦 KZ 蒙古国 MN 乌兹别克斯坦 UZ 保加利亚 BG 白俄罗斯 BY 西班牙 ES 法国 FR 英国 GB 德国 DE 希腊 GR 爱尔兰 IE 意大利 IT 荷兰 NL 波兰 PL 罗马尼亚 RO 俄罗斯 RU 瑞典 SE 父主题: 附录
  • 请求参数 表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 查询结果的app数量 domain String 播放 域名 templates Array of AppQualityInfo objects 转码模板 表5 AppQualityInfo 参数 参数类型 描述 app_name String 应用名称 quality_info Array of QualityInfo objects 视频质量信息 表6 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帧对齐。 状态码:400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 直播转码模板查询成功 { "domain" : "play.example.com", "total" : 1, "templates" : [ { "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 } ] } ] } 状态码: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信息。
  • URI GET /v1/{project_id}/template/transcodings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 推流域名 app_name 否 String 应用名称 page 否 Integer 分页编号,默认为0。 size 否 Integer 每页记录数。 取值范围:1-100。 默认为10。
  • 请求参数 表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信息。
  • 响应参数 状态码: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 错误描述
  • 响应示例 状态码: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 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表5 响应Body参数 参数 参数类型 描述 play_domain String 直播播放域名 apps Array of GeoBlockingConfigInfo objects 应用列表 表6 GeoBlockingConfigInfo 参数 参数类型 描述 app String 应用名 area_whitelist Array of strings 限制区域列表, 空列表表示不限制。 除中国以外,其他地区代码,2位字母大写。代码格式参考ISO 3166-1 alpha-2 包含如下部分取值: CN-IN:中国大陆 CN-HK:中国香港 CN-MO:中国澳门 CN-TW:中国台湾 BR:巴西 状态码:400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码:200 查询地域限制配置列表成功 { "play_domain" : "play.example.huawei.com", "apps" : [ { "app" : "live,", "area_whitelist" : [ "CN-IN", "CN-HK", "CN-MO", "CN-TW", "BR" ] } ] } 状态码:400 查询地域限制配置列表失败 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
  • 响应参数 状态码:201 表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 错误描述
  • 请求示例 创建录制规则。 POST https://{endpoint}/v1/{project_id}/record/rules { "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/" } } }
  • 请求参数 表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