华为云用户手册

  • URI DELETE /v1/{project_id}/stream/blocks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain 是 String 推流 域名 app_name 是 String 应用名称 stream_name 是 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" }
  • 请求参数 表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/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。 若参数为空,默认为当前时间。结束时间需大于起始时间。 说明: 当按需产品按小时或按天进行结算费用时,当月最后一个结算周期的用量会在次月1号完成扣费,因此账单费用归属到次月。 按小时结算的按需资源示例: 2021/11/30 23:00:00-2021/12/01 00:00:00的转码用量在2021/12/01 00:00:00开始上报用量给计费系统, 计费系统在2021/12/01 00:36:00完成扣费处理。 这条用量对应的账单消费时间是2021/11/30 23:00:00-2021/12/01 00:00:00,交易时间是2021/12/0:00,因此账期归属在2021年12月。
  • 响应参数 状态码: 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 错误描述。
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 LIVE.100011001 Invalid request parameter. 请求参数非法。 可能缺少必要参数,或者参数值格式不正确,具体错误信息请查看错误描述 error_detail 字段。 400 LIVE.100011004 The protocol is not supported. The API only supports the HTTPS protocol. 协议不支持,当前API仅支持https协议,不支持http协议 请使用https协议 400 LIVE.100011006 This API is not supported in this version or is in the maintenance state. 本版本内不支持此接口或该接口处于维护状态 请稍后重试或者联系客服人员帮忙解决 400 LIVE.100011008 The API is in the maintenance state. 当前接口处于停服维护状态 请稍后重试,或提交工单,申请技术客服协助解决问题 400 LIVE.100011009 The requested user does not exist. 请求用户不存在 请确认用户的输入信息是否正确 400 LIVE.100011011 The method specified in the request is not supported. 处理禁用请求中指定的方法 确认请求的http方法是否正确 400 LIVE.100011012 Unsupported media type. 不支持的媒体类型异常 提交工单,申请技术客服协助解决问题 400 LIVE.100011013 You have not completed real-name authentication. 用户没有实名认证 请先进行实名认证 400 LIVE.100011022 LIVE.Record task exist. 录制任务已存在 停止录制命令下发之后,再次对相同流下发开始录制命令,必须间隔10秒以上。 400 LIVE.103011018 The resource already exists. 资源已存在 确认要操作的资源是否已经存在 400 LIVE.103011020 The maximum number of domain names has been reached. 域名数量超过配额 超过租户最大域名添加上限,删除不必要的域名再添加;如确有必要超额添加,请提交工单申请技术客服审核 400 LIVE.103011021 Failed to access the database. 访问DB失败 提交工单,申请技术客服协助解决问题 400 LIVE.103011022 This operation is not allowed in the current state. 当前域名的状态不支持此操作 确认域名当前状态:非停用状态不可修改、删除 400 LIVE.103011024 The ICP number does not exist. 域名对应的ICP编号不存在 请检查ICP编号是否正确 400 LIVE.103011025 The approved ICP number cannot be modified. 审核通过的许可证号不允许修改 ICP编号在首次添加审核通过后不允许修改,如有修改必要请提交工单,申请技术客服协助解决问题 400 LIVE.103011026 The domain name is in the blacklist. 域名在黑名单网站中 更换合法注册的域名进行操作 400 LIVE.103011027 The domain name is in the blacklist. 域名在非法接入黑名单中 更换合法注册的域名进行操作 400 LIVE.103011029 The domain name is in gray configuration. 此域名存在灰度配置,配置下发失败 提交工单,申请技术客服协助解决问题 400 LIVE.103011030 This domain name has customized configuration. 此域名存在定制化配置,配置下发失败 提交工单,申请技术客服协助解决问题 401 LIVE.100011002 Identity authentication failed. 身份认证失败。 一般是由于签名计算错误导致的,请参考文档中签名方法部分。 401 LIVE.100011003 You do not have permission to access the API. 未授权访问接口 请联系主账号管理员开通接口权限 401 LIVE.100011014 Your account is not allowed to access the service, because it is frozen, deleted, or has insufficient balance. 用户当前状态不允许访问,比如冻结、删除、余额不足。 华为云账户异常,请确认是否处于欠费冻结或停用状态 401 LIVE.100011015 Project ID verification failed. projectID校验失败 确认请求中的项目ID及请求头部 403 LIVE.103011016 Invalid request content. 请求内容非法 请求参数不合规范 404 LIVE.103011019 The resource does not exist. 资源不存在 确认要操作的资源是否存在或租户账号信息是否正确 500 LIVE.100011000 Internal communication error. 内部服务器通信异常 提交工单,申请技术客服协助解决问题 500 LIVE.100011005 Internal server error. 服务器内部出现错误 请稍后重试或者联系客服人员帮忙解决 500 LIVE.100011007 The number of concurrent API requests exceeds the upper limit. 接口请求超过并发限制 提交工单,申请技术客服协助解决问题 500 LIVE.103011017 Failed to synchronize data to CDN. 同步数据到CDN失败 确认域名是否已经备案并向有关部门申请取得许可;如果确认域名合法依然失败,请提交工单,申请技术客服协助解决问题 500 LIVE.103011023 Failed to synchronize the domain name to GSLB. 同步域名到GSLB失败 提交工单,申请技术客服协助解决问题 500 LIVE.103011028 Failed to synchronize the domain name to DNS. 同步域名到DNS失败 提交工单,申请技术客服协助解决问题 父主题: 附录
  • 响应参数 状态码: 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 视频PTS。 单位ms。 last_audio_pts Long 音频PTS。 单位ms。 last_video_audio_pts_diff Long 音视频PTS差值。 单位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" : "livepush-test.huaweicloud.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" }
  • 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天,最大查询周期7天。 若参数为空,默认查询最近1小时数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度1天,最大查询周期7天。 若参数为空,默认为当前时间。结束时间需大于起始时间。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 cdn_ips Array of CdnIp objects IP归属信息列表。 表5 CdnIp 参数 参数类型 描述 ip String 需查询的IP地址。 belongs Boolean 是否是华为云CDN节点。 region String IP归属地省份。Unknown:表示未知归属地 isp String 运营商名称。如果IP归属地未知,该字段返回null。 platform String 平台名称。如果平台名称未知,该字段返回null。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 查询IP归属信息,格式1:多个IP地址参数使用"&"拼接。 GET https://{endpoint}/v1/{project_id}/cdn/ip-info?ip=192.168.1.1&ip=192.168.1.2 查询IP归属信息,格式2:IP地址列表以“,”分割。 GET https://{endpoint}/v1/{project_id}/cdn/ip-info?ip=192.168.1.1,192.168.1.2
  • 请求参数 表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 查询成功 { "cdn_ips" : [ { "ip" : "192.168.1.1", "region" : "Sichuan", "platform" : null, "isp" : "Dianxin", "belongs" : true }, { "ip" : "192.168.1.2", "region" : "Unknown", "platform" : null, "isp" : null, "belongs" : false } ] } 状态码: 400 参数错误 { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } 状态码: 500 服务内部错误 { "error_code" : "LIVE.100011005", "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve" }
  • 响应示例 状态码: 200 查询播放域名延时配置成功 { "play_domain" : "pull.example.test.com", "delay_config" : [ { "app" : "live", "delay" : 6000 } ] } 状态码: 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参数 参数 参数类型 描述 play_domain String 播放域名 delay_config Array of DelayConfig objects 直播延时配置 表5 DelayConfig 参数 参数类型 描述 app String 应用名,默认为live delay Integer 延时时间,单位:ms。 包含如下取值: 2000(低)。 4000(中)。 6000(高)。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 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信息。
  • 国家名称缩写 表1 国家名称缩写 国家 英文缩写 阿富汗 AF 奥兰群岛 AX 阿尔巴尼亚 AL 阿尔及利亚 DZ 美属萨摩亚 AS 安道尔 AD 安哥拉 AO 安圭拉 AI 安提瓜和巴布达 AG 阿根廷 AR 亚美尼亚 AM 阿鲁巴 AW 澳大利亚 AU 奥地利 AT 阿塞拜疆 AZ 孟加拉 BD 巴林 BH 巴哈马 BS 巴巴多斯 BB 比利时 BE 伯利兹 BZ 贝宁 BJ 百慕大 BM 不丹 BT 玻利维亚 BO 波斯尼亚和黑塞哥维那 BA 博茨瓦纳 BW 布维岛 BV 巴西 BR 文莱 BN 保加利亚 BG 布基纳法索 BF 布隆迪 BI 柬埔寨 KH 喀麦隆 CM 加拿大 CA 佛得角 CV 中非 CF 乍得 TD 智利 CL 圣诞岛 CX 科科斯(基林)群岛 CC 哥伦比亚 CO 科摩罗 KM 刚果(金) CD 刚果 CG 库克群岛 CK 哥斯达黎加 CR 科特迪瓦 CI 中国 CN 克罗地亚 HR 捷克 CZ 塞浦路斯 CY 丹麦 DK 吉布提 DJ 多米尼加 DM 厄瓜多尔 EC 埃及 EG 赤道几内亚 GQ 厄立特里亚 ER 爱沙尼亚 EE 埃塞俄比亚 ET 法罗群岛 FO 斐济 FJ 芬兰 FI 法国 FR 法国大都会 FX 法属圭亚那 GF 法属波利尼西亚 PF 加蓬 GA 冈比亚 GM 格鲁吉亚 GE 德国 DE 加纳 GH 直布罗陀 GI 希腊 GR 格林纳达 GD 瓜德罗普岛 GP 关岛 GU 危地马拉 GT 根西岛 GG 几内亚比绍 GW 几内亚 GN 圭亚那 GY 海地 HT 洪都拉斯 HN 匈牙利 HU 冰岛 IS 印度 IN 印度尼西亚 ID 伊拉克 IQ 爱尔兰 IE 马恩岛 IM 意大利 IT 牙买加 JM 日本 JP 泽西岛 JE 约旦 JO 哈萨克斯坦 KZ 肯尼亚 KE 基里巴斯 KI 韩国 KR 科威特 KW 吉尔吉斯斯坦 KG 老挝 LO 拉脱维亚 LV 黎巴嫩 LB 莱索托 LS 利比里亚 LR 利比亚 LY 列支敦士登 LI 立陶宛 LT 卢森堡 LU 北马其顿 MK 马拉维 MW 马来西亚 MY 马达加斯加 MG 马尔代夫 MV 马里 ML 马耳他 MT 马绍尔群岛 MH 马提尼克岛 MQ 毛里塔尼亚 MR 毛里求斯 MU 马约特 YT 墨西哥 MX 密克罗尼西亚 MF 摩尔多瓦 MD 摩纳哥 MC 蒙古 MN 黑山 ME 蒙特塞拉特 MS 摩洛哥 MA 莫桑比克 MZ 缅甸 MM 纳米比亚 NA 瑙鲁 NR 尼泊尔 NP 荷兰 NL 新喀里多尼亚 NC 新西兰 NZ 尼加拉瓜 NI 尼日尔 NE 尼日利亚 NG 纽埃 NU 诺福克岛 NF 挪威 NO 阿曼 OM 巴基斯坦 PK 帕劳 PW 巴拿马 PA 巴布亚新几内亚 PG 秘鲁 PE 菲律宾 PH 皮特凯恩群岛 PN 波兰 PL 葡萄牙 PT 波多黎各 PR 卡塔尔 QA 留尼汪岛 RE 罗马尼亚 RO 卢旺达 RW 圣赫勒拿 SH 圣基茨和尼维斯 KN 圣卢西亚 LC 圣文森特和格林纳丁斯 VG 萨尔瓦多 SV 萨摩亚 WS 圣马力诺 SM 圣多美和普林西比 ST 沙特阿拉伯 SA 塞内加尔 SN 塞舌尔 SC 塞拉利昂 SL 新加坡 SG 塞尔维亚 RS 斯洛伐克 SK 斯洛文尼亚 SI 所罗门群岛 SB 索马里 SO 南非 ZA 西班牙 ES 斯里兰卡 LK 苏里南 SR 斯威士兰 SZ 瑞典 SE 瑞士 CH 塔吉克斯坦 TJ 坦桑尼亚 TZ 泰国 TH 特立尼达和多巴哥 TT 东帝汶 TL 多哥 TG 托克劳 TK 汤加 TO 突尼斯 TN 土耳其 TR 土库曼斯坦 TM 图瓦卢 TV 乌干达 UG 乌克兰 UA 阿拉伯联合酋长国 AE 英国 UK 美国 US 乌拉圭 UY 乌兹别克斯坦 UZ 瓦努阿图 VU 梵蒂冈 VA 委内瑞拉 VE 越南 VN 瓦利斯群岛和富图纳群岛 WF 也门 YE 赞比亚 ZM 津巴布韦 ZW 父主题: 附录
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 bucket 是 String OBS桶名 operation 是 Integer 操作 1:授权 0:取消授权
  • 操作步骤 获取用户Token,用于调用直播接口时进行认证鉴权。 详细信息请参见构造请求。以“华北-北京四”为示例,若您需要调用其它区域的直播接口,请替换成对应区域的IAM终端节点。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "projectname" } } } } 如图1所示,红框中的信息为获取用户Token。 图1 获取用户Token 选择POST请求方法,并输入请求URI。 POST https://live.cn-north-4.myhuaweicloud.com/v1/{project_id}/template/transcodings “live.cn-north-4.myhuaweicloud.com”为直播服务的终端节点,您可以在终端节点中获取。 调用IAM接口的区域需与调用直播接口的区域一致,如调用“cn-north-4”区域的IAM接口获取用户Token,则该Token仅能用于调用“cn-north-4”区域直播接口的鉴权。 在请求消息头中增加“X-Auth-Token”,值设置为1中获取的用户Token。 在请求消息体中传入如下所示的参数,具体参数说明可参考创建直播转码模板接口。 { "domain": "play.example.com", "app_name": "live", "quality_info": [ { "templateName": "", "quality": "lsd", "hdlb": "off", "PVC": "off", "codec": "H264", "width": 854, "height": 480, "bitrate": 600, "video_frame_rate": 0, "protocol": "HLS", "iFrameInterval": 0 } ] } 请求响应成功后,无返回参数,状态码为201 Created。 若请求失败,返回如下所示的错误码及错误描述,状态码为400 Bad Request。 "error_code": "LIVE.100011001", "error_msg": "模板配置校验失败"
  • 请求参数 表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 直播域名 guard_switch 是 String referer防盗链开关:true表示开启;false表示关闭 referer_config_empty 否 String 是否包含referer头域:true表示包含;false表示不包含;guard_switch为true则必填 referer_white_list 否 String 是否为referer白名单:true表示白名单;false表示黑名单;guard_switch为true则必填 referer_auth_list 否 Array of strings 域名列表,域名为正则表达式;最多支持配置100个域名,以英文“;”进行分隔;guard_switch为true则必填
  • 请求示例 PUT https://{endpoint}/v1/{project_id}/guard/referer-chain { "domain" : "play.example.huawei.com", "guard_switch" : "true", "referer_config_empty" : "true", "referer_white_list" : "false", "referer_auth_list" : [ "^http://test.*com$", "abc.com" ] }
  • 地区名称缩写 表1 地区名称缩写 地区 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX 山东 SD 福建 FJ 安徽 AH 四川 SC 西藏 XZ 陕西 SN 青海 QH 新疆 XJ 甘肃 GS 贵州 GZ 湖北 HB 湖南 HN 河南 HA 香港 HK 澳门 MO 台湾 TW 父主题: 附录
  • 请求参数 表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" }
  • 响应示例 状态码: 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" }
共100000条