文件

取消异步任务

1.接口说明

接口路径:/efile/openapi/v2/file/task/cancel

请求方式:POST

请求数据类型:application/json

接口描述:取消异步任务接口，用于取消异步复制/移动/删除任务（建议每次取消100个任务,最多不超过500）。

2.请求消息

请求参数:

Headers:

名称	类型	必填	描述	示例
token	string	是	接口凭证	eyJhbGciOiJIUzI1N...

参数:

名称	类型	必填	描述	示例
taskIds	array	是	任务id列表（异步复制/移动/删除接口，返回参数中的taskId）	["254653d8816b4407ba27a9d004342c0e", "3dc8b0a6b508469b8554bc7f72ea006d"]

3.请求示例

cURL请求示例

curl --location 'https://scnet-demo.accloud.cn/efile/openapi/v2/file/task/cancel' \
--header 'token: <Token>' \
--header 'Content-Type: application/json' \
--data '{
    "taskIds": [
        "254653d8816b4407ba27a9d004342c0e"
    ]
}'

Java请求示例

import okhttp3.*;

public class FileCopyDemo {

    public static final String TOKEN = "<Token>";
    
    public static final String URL = "https://scnet-demo.accloud.cn/efile/openapi/v2/file/task/cancel";

    public static void main(String[] args) throws Exception {
        String requestBodyJson = "{\n" +
                "    \"taskIds\": [\n" +
                "        \"254653d8816b4407ba27a9d004342c0e\"\n" +
                "    ]\n" +
                "}";
        
        OkHttpClient client = new OkHttpClient().newBuilder()
                .build();
        MediaType mediaType = MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType, requestBodyJson);
        Request request = new Request.Builder()
                .url(URL)
                .method("POST", body)
                .addHeader("token", TOKEN)
                .addHeader("Content-Type", "application/json")
                .build();
        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

Python请求示例

import requests
import json

url = "https://scnet-demo.accloud.cn/efile/openapi/v2/file/task/cancel"

payload = json.dumps({
    "taskIds": [
        "254653d8816b4407ba27a9d004342c0e"
    ]
})
headers = {
    "token": "<Token>",
    'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

4.响应消息

返回参数:

名称	类型	说明
msg	string	异常时的详细异常信息
code	string	0：成功，10003：参数异常，911020：文件不存在，911021：文件已存在，911501：空间不足，911507：源文件与目标文件一致,禁止操作，911009：区域用户不存在，911030：权限不足，10001：其它异常
data	array
taskId	string	任务id
result	boolean	取消结果，如果任务已完成或者已失败，则会取消失败
status	string	任务状态 可选值： 取消：cancel， 完成：complete， 失败：fail

返回示例:

{
  "code": "0",
  "data": [
    {
      "taskId": "254653d8816b4407ba27a9d004342c0e",
      "result": true,
      "status": "cancel"
    }
  ],
  "msg": "success"
}

5.错误码

错误码	说明
0	成功
10001	内部异常（其他异常）
10003	参数不全
10004	参数无效
10009	不支持的版本
911009	区域用户不存在
911020	文件不存在
911021	文件已存在
911022	目标地址不是一个文件夹
911025	分享文件已存在，请重命名后分享
911029	文件路径包含特殊字符，请重命名后再操作
911030	权限不足，禁止操作
911031	文件重命名失败
911034	分享链接创建失败，请重新分享
911404	ac认证服务端连接异常
911406	服务端token认证异常，未取到关联用户
911501	存储空间不足
911502	目录非空，操作失败
911504	命令执行超时
911505	文件大小超出预设大小,无法预览
911506	文件类型不在预设范围内,不允许打开
911507	源文件与目标文件一致,禁止操作
911700	文件名包含非法字符，请重命名后再操作
911048	服务繁忙，触发限流，请稍后再试