Deskripsi panggilan API
Langkah 1: Panggil API ini untuk mendapatkan informasi unduhan file, termasuk URL unduhan dan header. Langkah 2: Jalankan proses unduh. Lihat contoh berikut:public static void main(String[] args) {
String url = ""; // internalResourceUrls yang dikembalikan oleh API dapatkan informasi unduhan.
String path = "/Users/xxxxx/Downloads/test.txt"; // Jalur target untuk unduhan file.
// Header yang dikembalikan oleh API dapatkan informasi unduhan.
Map<String, String> headers = "" // Header yang diperoleh dari API dapatkan informasi unduhan.
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url(url)
.headers(Headers.of(headers))
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
Sink sink = null;
BufferedSink bufferedSink = null;
try {
File dest = new File(path);
sink = Okio.sink(dest);
bufferedSink = Okio.buffer(sink);
bufferedSink.writeAll(response.body().source());
} catch (Exception e) {
e.printStackTrace();
} finally {
if (bufferedSink != null) {
bufferedSink.close();
}
if (sink != null) {
sink.close();
}
}
}
});
}
Jika file terlalu besar dan Anda perlu mengambilnya secara bertahap, tambahkan bidang headers pada contoh di atas:
headers.put("Range","bytes=0-499");. Untuk detailnya, lihat Mengunduh sebagian konten dengan menentukan Range.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/downloadInfos/query |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-Storage.DownloadInfo.Read-Izin baca untuk informasi unduhan file penyimpanan organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Mendapatkan access token aplikasi internal. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Menambahkan ruang untuk mendapatkan nilai parameter id. |
| dentryId | String | Ya | ID file. Panggil API Mendapatkan daftar file atau folder atau API Mendapatkan spaceId berdasarkan dentryUuid untuk mendapatkan nilai parameter id. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId dari operator. Panggil API Mengkueri detail pengguna untuk mendapatkannya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| option | Object | Tidak | Parameter opsional. |
| version | Long | Tidak | Nomor versi file. Panggil API Mendapatkan daftar versi file untuk mendapatkan versinya. |
| preferIntranet | Boolean | Tidak | Apakah akan mengutamakan transmisi intranet. Parameter ini memerlukan konfigurasi transmisi intranet penyimpanan khusus. - true: Ya (default) - false: Tidak |
Contoh permintaan
HTTPPOST /v1.0/storage/spaces/854xxxx/dentries/798xxxxx/downloadInfos/query?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"option" : {
"version" : 1,
"preferIntranet" : false
}
}
// 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 using 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.GetFileDownloadInfoHeaders getFileDownloadInfoHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetFileDownloadInfoHeaders();
getFileDownloadInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.GetFileDownloadInfoRequest.GetFileDownloadInfoRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetFileDownloadInfoRequest.GetFileDownloadInfoRequestOption()
.setVersion(1L)
.setPreferIntranet(false);
com.aliyun.dingtalkstorage_1_0.models.GetFileDownloadInfoRequest getFileDownloadInfoRequest = new com.aliyun.dingtalkstorage_1_0.models.GetFileDownloadInfoRequest()
.setUnionId("chyxxxxx")
.setOption(option);
try {
client.getFileDownloadInfoWithOptions("854xxxx", "798xxxxx", getFileDownloadInfoRequest, getFileDownloadInfoHeaders, 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 properties, which help locate issues
}
} 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 properties, which help locate issues
}
}
}
}
# -*- 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 using 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_file_download_info_headers = dingtalkstorage__1__0_models.GetFileDownloadInfoHeaders()
get_file_download_info_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.GetFileDownloadInfoRequestOption(
version=1,
prefer_intranet=False
)
get_file_download_info_request = dingtalkstorage__1__0_models.GetFileDownloadInfoRequest(
union_id='chyxxxxx',
option=option
)
try:
client.get_file_download_info_with_options('854xxxx', '798xxxxx', get_file_download_info_request, get_file_download_info_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 properties, which help locate issues
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_file_download_info_headers = dingtalkstorage__1__0_models.GetFileDownloadInfoHeaders()
get_file_download_info_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.GetFileDownloadInfoRequestOption(
version=1,
prefer_intranet=False
)
get_file_download_info_request = dingtalkstorage__1__0_models.GetFileDownloadInfoRequest(
union_id='chyxxxxx',
option=option
)
try:
await client.get_file_download_info_with_options_async('854xxxx', '798xxxxx', get_file_download_info_request, get_file_download_info_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 properties, which help locate issues
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\GetFileDownloadInfoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetFileDownloadInfoRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetFileDownloadInfoRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$getFileDownloadInfoHeaders = new GetFileDownloadInfoHeaders([]);
$getFileDownloadInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
$option = new option([
"version" => 1,
"preferIntranet" => false
]);
$getFileDownloadInfoRequest = new GetFileDownloadInfoRequest([
"unionId" => "chyxxxxx",
"option" => $option
]);
try {
$client->getFileDownloadInfoWithOptions("854xxxx", "798xxxxx", $getFileDownloadInfoRequest, $getFileDownloadInfoHeaders, 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 properties, which help locate issues
}
}
}
}
$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"
)
/**
* Initialize the account Client using 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
}
getFileDownloadInfoHeaders := &dingtalkstorage_1_0.GetFileDownloadInfoHeaders{}
getFileDownloadInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
option := &dingtalkstorage_1_0.GetFileDownloadInfoRequestOption{
Version: tea.Int64(1),
PreferIntranet: tea.Bool(false),
}
getFileDownloadInfoRequest := &dingtalkstorage_1_0.GetFileDownloadInfoRequest{
UnionId: tea.String("chyxxxxx"),
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetFileDownloadInfoWithOptions(tea.String("854xxxx"), tea.String("798xxxxx"), getFileDownloadInfoRequest, getFileDownloadInfoHeaders, &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 properties, which help locate issues
}
}
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 {
/**
* Initialize the account Client using 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 getFileDownloadInfoHeaders = new $dingtalkstorage_1_0.GetFileDownloadInfoHeaders({ });
getFileDownloadInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
let option = new $dingtalkstorage_1_0.GetFileDownloadInfoRequestOption({
version: 1,
preferIntranet: false,
});
let getFileDownloadInfoRequest = new $dingtalkstorage_1_0.GetFileDownloadInfoRequest({
unionId: "chyxxxxx",
option: option,
});
try {
await client.getFileDownloadInfoWithOptions("854xxxx", "798xxxxx", getFileDownloadInfoRequest, getFileDownloadInfoHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message properties, which help locate issues
}
}
}
}
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
{
/**
* Initialize the account Client using 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.GetFileDownloadInfoHeaders getFileDownloadInfoHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetFileDownloadInfoHeaders();
getFileDownloadInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetFileDownloadInfoRequest.GetFileDownloadInfoRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetFileDownloadInfoRequest.GetFileDownloadInfoRequestOption
{
Version = 1,
PreferIntranet = false,
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetFileDownloadInfoRequest getFileDownloadInfoRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetFileDownloadInfoRequest
{
UnionId = "chyxxxxx",
Option = option,
};
try
{
client.GetFileDownloadInfoWithOptions("854xxxx", "798xxxxx", getFileDownloadInfoRequest, getFileDownloadInfoHeaders, 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 properties, which help locate issues
}
}
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 properties, which help locate issues
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| protocol | String | Protokol unduhan file. - HEADER_SIGNATURE: Permintaan bertanda tangan pada header |
| headerSignatureInfo | Object | Informasi permintaan bertanda tangan pada header. Bidang ini berlaku ketika nilai bidang protocol adalah HEADER_SIGNATURE. |
| resourceUrls | Array of String | Beberapa URL unduhan. URL yang tercantum lebih awal memiliki prioritas lebih tinggi. |
| headers | Map<String, String> | Informasi header permintaan. |
| expirationSeconds | Integer | Waktu kedaluwarsa, dalam detik. |
| region | String | Wilayah. - ZHANGJIAKOU: Zhangjiakou - SHENZHEN: Shenzhen - SHANGHAI: Shanghai - SINGAPORE: Singapura - UNKNOWN: Tidak diketahui |
| internalResourceUrls | Array of String | URL intranet. Bidang ini saat ini belum memiliki kasus penggunaan. Abaikan saja. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"protocol" : "HEADER_SIGNATURE",
"headerSignatureInfo" : {
"resourceUrls" : [ "resource_url" ],
"headers" : {
"key" : "header_value"
},
"expirationSeconds" : 900,
"region" : "ZHANGJIAKOU",
"internalResourceUrls" : [ "internal_resource_url" ]
}
}
Kode error
Jika terjadi error saat Anda memanggil API ini, temukan solusi berdasarkan pesan error di dokumen Kode error global.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 403 | orgAuthLevelNotEnough | auth level of org is not enough | Tingkat autentikasi organisasi terlalu rendah. |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk mengunduh file. |
| 400 | paramError | %s | Error parameter. |
| 400 | paramError.spaceId | %s | Error parameter - spaceId. |
| 400 | paramError.dentryId | %s | Error parameter - dentryId. |
| 400 | operationNotSupported | %s | File tidak mendukung unduhan. |
| 400 | dentryDownloadProtocolNotSupport | %s | Protokol unduhan tidak didukung. |
| 400 | fileArchived | %s | File telah diarsipkan. Pembatalan pengarsipan dipicu secara otomatis. Coba lagi nanti. |
| 404 | spaceNotExist | %s | Ruang tidak ada. |
| 404 | dentryNotExist | %s | File tidak ada. |
| 500 | systemError | %s | Error sistem. |
| 500 | unknownError | Unknown Error | Error tidak diketahui. |
| 503 | operationTimeout | %s | Permintaan melebihi batas waktu. |