Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/tasks/{taskId} |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Storage.Task.Read-Read permission for organization storage tasks |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an authorized organization for a third-party app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| taskId | String | Yes | The ID of the async task in storage. Call the Bulk move files or folders API to obtain the value of the taskId parameter. For example, the async task ID of a bulk move operation on files or folders. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the operator. Call the Query user details API to obtain it. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| task | Object | The task information. |
| id | String | The task ID. |
| status | String | The task status. - INIT: Initialized - IN_PROGRESS: In progress - SUCCESS: Succeeded - FAIL: Failed |
| totalCount | Long | The total number of subtasks. |
| successCount | Long | The number of successful subtasks. |
| failCount | Long | The number of failed subtasks. |
| failMessage | String | The reason for the task failure. |
| beginTime | String | The task start time, in ISO 8601 format. For example, 2022-07-29T14:55Z. |
| endTime | String | The task end time, in ISO 8601 format. For example, 2022-07-29T14:55Z. |
Response body example
Error codes
If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | paramError | %s | Parameter error |
| 400 | paramError.taskId | %s | Parameter error - taskId |
| 404 | taskNotExist | %s | The task does not exist |
| 500 | systemError | %s | System error |
| 500 | unknownError | Unknown Error | Unknown error |
| 503 | operationTimeout | %s | Request timeout |