Skip to content

上传进度查询

查询文档上传的进度,以及处理失败时的具体错误原因

基本信息

请求方法:GET

请求路径:/api/v1/openapi/appspace/file/async/upload/:task_id

请求主机:developer.kdocs.cn

限流频次

应用类型限额
测试应用
10,000 次/天
正式应用
1,000,000 次/天

权限范围

提示

应用文档不属于用户文档,不做权限要求。

参数必须类型说明
Date
string
使用 RFC1123 时间格式的当前时间
Content-Md5
string
HTTP Body 中数据的 MD5 值十六进制表达方式, 必需小写, 如果是 get 请求一律使用 URI 计算 MD5
Content-Type
string
目前固定为: application/json
Authorization
string
"WPS-2:" + app_id + ":" + sha1( app_key + Content-Md5 + Content-Type + DATE)

Path 参数

参数必须类型说明
task_id
string
异步任务 ID

返回参数

参数类型说明
code
integer
错误码
+
data
data {}
响应数据

示例

请求示例

curl --request PUT \
	--url https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id \
	--header 'Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a' \
	--header 'Content-Md5: d41d8cd98f00b204e9800998ecf8427e' \
	--header 'Content-Type: application/json' \
	--header 'Date: Wed, 23 Jan 2013 06:43:08 GMT'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id")
	.put(null)
	.addHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	.addHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	.addHeader("Content-Type", "application/json")
	.addHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")
	.build();

Response response = client.newCall(request).execute();
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	req.Header.Add("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

headers = {
    'Date': "Wed, 23 Jan 2013 06:43:08 GMT",
    'Content-Md5': "d41d8cd98f00b204e9800998ecf8427e",
    'Content-Type': "application/json",
    'Authorization': "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a"
    }

conn.request("PUT", "/api/v1/openapi/appspace/file/async/upload/:task_id", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "PUT",
	CURLOPT_HTTPHEADER => [
		"Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a",
		"Content-Md5: d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type: application/json",
		"Date: Wed, 23 Jan 2013 06:43:08 GMT"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("PUT", "https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id");
xhr.setRequestHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
xhr.setRequestHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");

xhr.send(data);
const http = require("https");

const options = {
	"method": "PUT",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/appspace/file/async/upload/:task_id",
	"headers": {
		"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
		"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type": "application/json",
		"Authorization": "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a"
	}
};

const req = http.request(options, function (res) {
	const chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
		const body = Buffer.concat(chunks);
		console.log(body.toString());
	});
});

req.end();
CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Date: Wed, 23 Jan 2013 06:43:08 GMT");
headers = curl_slist_append(headers, "Content-Md5: d41d8cd98f00b204e9800998ecf8427e");
headers = curl_slist_append(headers, "Content-Type: application/json");
headers = curl_slist_append(headers, "Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/appspace/file/async/upload/:task_id");
var request = new RestRequest(Method.PUT);
request.AddHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
request.AddHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
IRestResponse response = client.Execute(request);

返回示例

{
  "code": 0,
  "data": {
    "task_id": "mnzspiqmtutjbotggcjtfbbolpztcdyg",
    "progress": {
      "current": 227,
      "total": 227
    },
    "status": "success",
    "file_token": "tSPf3Vb82r2z94Dob2cRLrd"
  }
}

错误码

请参考错误码说明