文档

CancelUrlUploadJobs - 取消URL上传任务

取消排队中的URL上传任务。

接口说明

  • 只能取消任务状态为 Pending 的 URL 上传任务,可通过 GetURLUploadInfos 接口查询任务状态。
  • 已经开始执行的上传任务无法取消。
  • 请求参数 JobIds 和 UploadUrls 必须指定一个,二者同时传入时只处理 JobIds。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
JobIdsstring

任务 ID 列表,任务 ID(JobId)可以通过 GetPlayInfo 接口中返回的 PlayInfo 结构体中获取。

  • 最多支持 10 个 ID。
  • 多个 ID 之间使用半角逗号(,)分隔。
说明 JobIds 和 UploadUrls 必须指定一个,二者同时传入时只处理 JobIds。
341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****
UploadUrlsstring

上传源视频 URL 列表。多个 URL 之间使用半角逗号(,)分隔,最多支持 10 个。

说明
  • 使用前,先进行 URL 编码。
  • JobIds 和 UploadUrls 必须指定一个,二者同时传入时只处理 JobIds。
  • http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    25818875-5F78-4D5C-3C3D-D7393642****
    CanceledJobsarray

    取消成功的任务列表。

    string

    取消成功的任务列表。返回值为 JobId。

    341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****
    NonExistsarray

    不存在的任务列表。

    string

    不存在的 JobId 或 URL 列表。

    如果请求参数为 JobIds,返回值为 JobId;如果请求参数为 UploadURLs,返回值为 URL。

    http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "25818875-5F78-4D5C-3C3D-D7393642****",
      "CanceledJobs": [
        "341c92e6c18dc435ee31253685****,0193d395194a83ad6ee2ef27a5b5****"
      ],
      "NonExists": [
        "http://www.example.aliyundoc.com/***/video01.mp4,http://www.example.aliyundoc.com/***/video02.mp4"
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-12-06API 内部配置变更,不影响调用查看变更详情