全部产品
Search

搜索本产品

    视频直播：SetLiveStreamPreloadTasks - 设置直播预热任务

    文档中心

    视频直播：SetLiveStreamPreloadTasks - 设置直播预热任务

    更新时间：Nov 14, 2024

    设置直播预热任务，支持批量设置直播流预热。

    接口说明

    • 调用本接口可支持批量设置直播流预热，最多可一次性设置 100 个直播 URL。
    • 直播预热仅不支持 HLS 格式的地址。

    QPS 限制

    本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:SetLiveStreamPreloadTasks
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DomainNamestring是

    播流域名。

    		example.com
    PlayUrlstring是

    直播 URL，支持批量设置多个直播 URL，多个 URL 之间用逗号（,）分隔，不超过 100 个。

    		rtmp://guide.aliyundoc.com/liveApp****/liveStream****
    Areastring否

    预热区域。取值：

    • domestic：中国内地。
    • overseas：海外及港澳台加速。
    • global：全球加速。

    如果不传该参数，默认的预热区域为您的域名所配置的加速区域。

    		domestic
    PreloadedStartTimestring否

    预热开始时间，UTC 格式，例如：2016-06-29T19:00:00Z，不填默认预热 1 小时。

    		2016-06-29T19:00:00Z
    PreloadedEndTimestring否

    预热结束时间，UTC 格式，例如：2016-06-30T19:00:00Z，EndTime 和 StartTime 之间的间隔不能超过 6 小时。

    		2016-06-30T19:00:00Z

    返回参数

    名称类型描述示例值
    object
    FailedURLinteger

    预热任务设置失败的 URL 条数。

    		0
    PreloadTasksMessagesarray<object>

    直播预热详细信息。

    PreloadTasksMessageobject

    直播预热详细信息。

    Descriptionstring

    预热任务是否成功。取值：

    • Successfully：成功。
    • InternalError：失败。
    		Successfully
    PlayUrlstring

    直播 URL。

    		rtmp://guide.aliyundoc.com/liveApp****/liveStream****
    TaskIdstring

    任务 ID。

    		yourTaskId
    RequestIdstring

    请求 ID。

    		36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5
    Statusstring

    任务状态。取值：

    • Success：成功。
    • Failed：失败。
    说明 只要有一条任务创建失败即为失败。
    		Success
    SuccessURLinteger

    预热任务设置成功的 URL 条数。

    		1
    TotalURLinteger

    预热任务里 URL 总条数。

    		1

    示例

    正常返回示例

    JSON格式

    {
  "FailedURL": 0,
  "PreloadTasksMessages": {
    "PreloadTasksMessage": [
      {
        "Description": "Successfully",
        "PlayUrl": "rtmp://guide.aliyundoc.com/liveApp****/liveStream****",
        "TaskId": "yourTaskId"
      }
    ]
  },
  "RequestId": "36E0E523-E0C6-5D95-A465-A8EA2DCBA2A5",
  "Status": "Success",
  "SuccessURL": 1,
  "TotalURL": 1
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParamParameter invalid.输入参数不合法
    400InvalidEndTime.MismatchSpecified end time does not match the specified start time.-
    400Duration.ExceedDuration between StartTime and EndTime is too long.-
    400QuotaExceeded.PreloadTaskslimitExceed max task count limit-
    400NoSpecialConfigurationno special configuration for domain name.该域名没有开启预热开关。
    500InternalErrorThe request processing has failed due to backend service exception.-

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史