请求
基本信息
| 字段 | 值 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/tasks/{taskId} |
| HTTP Method | GET |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-Storage.Task.Read-企业存储任务读权限 |
请求头
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证,通过以下获取: - 企业内部应用,调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用,调用获取第三方应用授权企业的accessToken接口获取。 |
路径参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| taskId | String | 是 | 存储中的异步任务ID,可调用批量移动文件或文件夹接口获取taskId参数值。 例如,批量移动文件或文件夹的异步任务ID。 |
查询参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| unionId | String | 是 | 操作人的unionId,可调用查询用户详情接口获取。 |
请求示例
HTTPGET /v1.0/storage/tasks/123xxxxx?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
} 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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
# -*- 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:
"""
使用 Token 初始化账号Client
@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 中含有 code 和 message 属性,可帮助开发定位问题
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 中含有 code 和 message 属性,可帮助开发定位问题
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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 {
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// 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"
)
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 {
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
Client.main(process.argv.slice(2));
// 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
{
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
}
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| task | Object | 任务信息。 |
| id | String | 任务ID。 |
| status | String | 任务状态。 - INIT:初始化 - IN_PROGRESS:进行中 - SUCCESS:成功 - FAIL:失败 |
| totalCount | Long | 子任务总数。 |
| successCount | Long | 子任务成功总数。 |
| failCount | Long | 子任务失败总数。 |
| failMessage | String | 任务失败原因。 |
| beginTime | String | 任务开始时间,iso8601格式,例如:2022-07-29T14:55Z。 |
| endTime | String | 任务结束时间,iso8601格式,例如:2022-07-29T14:55Z。 |
响应体示例
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"
}
}
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | paramError | %s | 参数错误 |
| 400 | paramError.taskId | %s | 参数错误-taskId |
| 404 | taskNotExist | %s | 任务不存在 |
| 500 | systemError | %s | 系统错误 |
| 500 | unknownError | Unknown Error | 未知错误 |
| 503 | operationTimeout | %s | 请求超时 |