> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the information of an async task in storage

> Call this API to query the execution status and result of async tasks in storage, applicable to async operations such as batch moving, copying, or deleting folders that contain child nodes.

Call this API to get the information of an async task in storage, including whether the async task is completed and whether it succeeded. For example, when bulk moving files or folders, bulk copying files or folders, or bulk deleting files or folders, the operation runs asynchronously if the target object contains child nodes.

## 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](/open/development/obtain-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](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) 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](/open/development/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](/open/development/query-user-details#) API to obtain it. |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
GET /v1.0/storage/tasks/123xxxxx?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkstorage_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkstorage_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.GetTaskHeaders getTaskHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetTaskHeaders();
        getTaskHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetTaskRequest getTaskRequest = new com.aliyun.dingtalkstorage_1_0.models.GetTaskRequest()
                .setUnionId("chyxxxxx");
        try {
            client.getTaskWithOptions("123xxxxx", getTaskRequest, getTaskHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes, which can help you troubleshoot the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message attributes, which can help you troubleshoot the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkstorage_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_task_headers = dingtalkstorage__1__0_models.GetTaskHeaders()
        get_task_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_task_request = dingtalkstorage__1__0_models.GetTaskRequest(
            union_id='chyxxxxx'
        )
        try:
            client.get_task_with_options('123xxxxx', get_task_request, get_task_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes, which can help you troubleshoot the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_task_headers = dingtalkstorage__1__0_models.GetTaskHeaders()
        get_task_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_task_request = dingtalkstorage__1__0_models.GetTaskRequest(
            union_id='chyxxxxx'
        )
        try:
            await client.get_task_with_options_async('123xxxxx', get_task_request, get_task_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes, which can help you troubleshoot the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetTaskHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetTaskRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $getTaskHeaders = new GetTaskHeaders([]);
        $getTaskHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getTaskRequest = new GetTaskRequest([
            "unionId" => "chyxxxxx"
        ]);
        try {
            $client->getTaskWithOptions("123xxxxx", $getTaskRequest, $getTaskHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message attributes, which can help you troubleshoot the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with a Token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkstorage_1_0.Client{}
  _result, _err = dingtalkstorage_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  getTaskHeaders := &dingtalkstorage_1_0.GetTaskHeaders{}
  getTaskHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getTaskRequest := &dingtalkstorage_1_0.GetTaskRequest{
    UnionId: tea.String("chyxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetTaskWithOptions(tea.String("123xxxxx"), getTaskRequest, getTaskHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message attributes, which can help you troubleshoot the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkstorage_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkstorage_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let getTaskHeaders = new $dingtalkstorage_1_0.GetTaskHeaders({ });
    getTaskHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getTaskRequest = new $dingtalkstorage_1_0.GetTaskRequest({
      unionId: "chyxxxxx",
    });
    try {
      await client.getTaskWithOptions("123xxxxx", getTaskRequest, getTaskHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes, which can help you troubleshoot the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetTaskHeaders getTaskHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetTaskHeaders();
            getTaskHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetTaskRequest getTaskRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetTaskRequest
            {
                UnionId = "chyxxxxx",
            };
            try
            {
                client.GetTaskWithOptions("123xxxxx", getTaskRequest, getTaskHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes, which can help you troubleshoot the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes, which can help you troubleshoot the issue
                }
            }
        }

    }
}
```

## Response

### 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

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "task" : {
    "id" : "123xxxxx",
    "status" : "IN_PROGRESS",
    "totalCount" : 6,
    "successCount" : 3,
    "failCount" : 1,
    "failMessage" : "permissionDenied",
    "beginTime" : "2022-01-01T10:00:00Z",
    "endTime" : "2022-01-01T10:00:00Z"
  }
}
```

### Error codes

If an error is returned when you call this API, look up the solution in the [Global error codes](/open/development/server-api-error-codes-1) 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          |