Create an Export Task

Function

This API is used by an application to create a resource export task.

Creating a new task with the same conditions overwrites the previous result file, addressing incomplete exports.
Each user can create up to 50 export tasks. Creating additional tasks will remove the earliest ones.
Each user can have up to five unfinished export tasks at a time.
File downloads are limited to one request every 30 seconds per user.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:exporttasks:create	Write	-	g:EnterpriseProjectId	-	-

URI

POST /v5/iot/{project_id}/export-tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Parameter description: type of the source resource to be exported. Batch task export is supported. Value: BatchTask
resource_condition	Yes	Object	Parameter description: resource filter criteria. The value is in JSON format and contains key-value pairs. When resource_type is set to BatchTasks, set the key to task_id and value to task_id of BatchTask (task_id is obtained from the batch task API). When app_type is set to APP, the exported result is within the app scope. Otherwise, the export result is filtered at the tenant level.
export_format	No	String	Parameter description: export format. Value: xls
app_type	No	String	Parameter description: effective scope of the tenant rule. The default value is GLOBAL. Range: GLOBAL: The rule takes effect for all resources under the tenant. APP: The rule takes effect for all resources under the application. If app_id is specified, the rule takes effect in the scope specified by app_id. If app_id is not specified, the rule takes effect in the scope of defaultApp.
app_id	No	String	Parameter description: resource space ID. This parameter is optional. If you have multiple resource spaces, you can specify this parameter to query tasks in a specified resource space. If this parameter is not carried, tasks in all resource spaces are queried. Value: The value can contain up to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
export_task_id	String	Unique ID of an export task.
resource_type	String	Type of the resource to be exported. Currently, only the batch task export type (BatchTask) is supported.
resource_condition	Object	Resource filter criteria. The value is in JSON format and contains key-value pairs. When resource_type is set to BatchTask, set key to task_id and value to task_id of BatchTask (task_id is obtained from the batch task API).
export_format	String	Export format. Currently, only the XLS format is supported.
status	String	Task status. Options: Processing, Success, and Failed.
export_count	Long	Number of exported resources.
progress	Integer	Progress of an export task. Range: 1 to 100 (complete).
create_time	String	Time when the product is created in the platform. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2020-08-12T12:12:12.333Z.
end_time	String	End time of the export task. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2020-08-12T12:12:12.333Z.
app_type	String	Application scope of the tenant rule. The default value is GLOBAL. Options: GLOBAL: The rule takes effect for all resources under the tenant. APP: The rule takes effect for all resources under the application. If app_id is specified, the rule takes effect in the scope specified by app_id. If app_id is not specified, the rule takes effect in the scope of defaultApp.
app_id	String	Application ID. This parameter is optional and is used in the scenario where old platform users have multiple applications. If you have multiple applications and need to use this API, this parameter must be carried to specify the application to which the created rule belongs. Otherwise, an error message is displayed. If you do not want to specify this parameter, contact Huawei technical support to merge your applications.

Example Requests

Creates an export task.

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"
}

Example Responses

Status code: 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"
}