创建导出任务
功能介绍
应用服务器可调用此接口创建资源导出任务。
-
同一个条件创建任务将会覆盖之前条件的任务结果文件(为了方便任务未执行完就导出后想重新导出完成任务的结果）。
-
单用户最多支持有50个导出任务，超出后将删除最先创建的导出任务。
-
单用户未完成的导出任务最多5个。
-
单用户下载导出文件最大速率为为30s一次。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/export-tasks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_type |
是 |
String |
参数说明：导出源资源类型，支持批量任务导出类型。 取值范围：BatchTask。 |
|
resource_condition |
是 |
Object |
参数说明：资源过滤条件，Json格式，里面是(K,V)键值对，当resource_type为BatchTasks时填写填写key为task_id，value为BatchTask的task_id(task_id从批量任务接口获得)。当app_type为APP时，导出的结果也会在该app范围内，否则为租户级别筛选。 |
|
export_format |
否 |
String |
参数说明：导出格式。 取值范围：xls。 |
|
app_type |
否 |
String |
参数说明: 租户规则的生效范围，默认GLOBAL。 取值范围：
|
|
app_id |
否 |
String |
参数说明：资源空间ID。此参数为非必选参数，存在多资源空间的用户需要使用该接口时，可以携带该参数查询指定资源空间下的任务列表，不携带该参数则会查询该用户下所有任务列表。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
export_task_id |
String |
导出任务唯一id。 |
|
resource_type |
String |
导出的资源类型，目前只支持批量任务导出类型BatchTask。 |
|
resource_condition |
Object |
资源过滤条件，Json格式，里面是(K,V)键值对，当resource_type为BatchTask时填写填写key为task_id，value为BatchTask的task_id（task_id从批量任务接口获得）。 |
|
export_format |
String |
导出格式，目前只支持xls格式。 |
|
status |
String |
任务状态，状态分别有：Processing：执行中，Success：成功，Failed：失败。 |
|
export_count |
Long |
已导出的资源数量。 |
|
progress |
Integer |
导出任务的执行进度，取值范围为1-100，当100表示进度为100%，任务完成。 |
|
create_time |
String |
在物联网平台创建产品的时间，格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'，如2020-08-12T12:12:12.333Z。 |
|
end_time |
String |
导出任务的执行结束时间，格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'，如2020-08-12T12:12:12.333Z。 |
|
app_type |
String |
租户规则的生效范围，默认GLOBAL，取值如下：
|
|
app_id |
String |
应用ID。此参数为非必选参数，用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时，必须携带该参数指定创建的规则归属到哪个应用下，否则接口会提示错误。如果用户存在多应用，同时又不想携带该参数，可以联系华为技术支持对用户数据做应用合并。 |
请求示例
创建导出任务。
POST https://{endpoint}/v5/iot/{project_id}/export-tasks
{
"resource_type" : "BatchTask",
"resource_condition" : {
"task_id" : "5f433ce0c24389024365fdfa"
},
"export_format" : "xls",
"app_type" : "APP",
"app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka"
}
响应示例
状态码：201
Created
{
"export_task_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
"resource_type" : "BatchTask",
"resource_condition" : {
"task_id" : "32822e5744a45ede319d2c50"
},
"export_format" : "xls",
"status" : "Processing",
"export_count" : 10000,
"progress" : "98,",
"create_time" : "2020-08-12T12:12:12.333Z",
"end_time" : "2020-08-12T12:12:12.333Z",
"app_type" : "string",
"app_id" : "string"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
403 |
FORBIDDEN |
错误码
请参见错误码。
