CreateDownloadTask - 创建文件下载任务

更新时间:
复制 MD 格式

创建文件下载任务。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:CreateDownloadTask

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Lang

string

否

接收消息的语言类型。

取值:

  • zh:(默认)中文

  • en:英文

zh

TaskType

string

否

任务类型,枚举值。可填枚举值见接口:查询文件下载任务类型。

InternetFirewallAsset

TaskData

string

否

下载任务的请求查询条件。本参数实际为必填项,未提供时 API 返回错误码 -340408(download task TaskData invalid),不可省略。

{\"SearchItem\":\"\",\"UserType\":\"buy\",\"IpVersion\":\"4\"}

TimeZone

string

否

下载文件中时间信息的时区,使用 IANA 时区标识符。默认为北京时间,即 Asia/Shanghai。

Asia/Shanghai

返回参数

名称

类型

描述

示例值

object

TaskId

integer

任务 Id,任务的唯一标识。注意:本字段仅在任务同步完成等特定条件下返回,常规响应仅返回 RequestId;请通过任务查询类接口获取任务状态与下载链接。

132

RequestId

string

返回结果的请求 ID。

E7F333E0-7B70-54DA-A307-4B2B49DEE923

TaskName

string

文件下载任务的名称。注意:本字段仅在任务同步完成等特定条件下返回,常规响应仅返回 RequestId。

test-IPv4

Status

string

任务状态。取值:

finish:任务完成。即任务已经完成,可以通过查询任务,获取任务文件下载链接。

start:任务开始。

error:任务失败。

expire:任务过期。即任务文件已经失效,无法下载。

注意:本字段仅在任务同步完成等特定条件下返回,常规响应仅返回 RequestId;请通过任务查询类接口查询实时状态。

start

示例

正常返回示例

JSON格式

{
  "TaskId": 132,
  "RequestId": "E7F333E0-7B70-54DA-A307-4B2B49DEE923",
  "TaskName": "test-IPv4",
  "Status": "start"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorAliUid Aliuid invalid. aliuid无效
400 ErrorDBInsertError A database insert error occurred. 内部错误:数据库插入错误
400 ErrorParameters The download task TaskData is invalid.

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

变更历史

更多信息,参考变更详情。