跳转到主要内容
调用本接口,提交文件。

接口调用说明

接口调用步骤如下: 步骤一:调用获取文件上传信息接口,获取上传文件需要的信息。 步骤二:使用OSS的header加签方式上传文件,参考示例: Java
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
public void test(){
               // 从接口返回信息中拿到url
                String resourceUrl = "第一步接口获取的resourceUrls";
              // 从接口返回信息中拿到headers
                Map<String, String> headers = 第一步接口获取的headers;
                URL url = new URL(resourceUrl);
                HttpURLConnection connection = (HttpURLConnection)url.openConnection();
               if (headers != null) {
                for (Map.Entry<String, String> entry : headers.entrySet()) {
                    connection.setRequestProperty(entry.getKey(), entry.getValue());
                }
            }
                connection.setDoOutput(true);
                connection.setRequestMethod("PUT");
                connection.setUseCaches(false);
                connection.setReadTimeout(10000);
                connection.setConnectTimeout(10000);
                connection.connect();
                OutputStream out = connection.getOutputStream();
                InputStream is = new FileInputStream(new File("/Users/xxxxx/Desktop/测试文件.xls"));
                byte[] b =new byte[1024];
                int temp;
                while ((temp=is.read(b))!=-1){
                       out.write(b,0,temp);
                }
                out.flush();
                out.close();
                int responseCode = connection.getResponseCode();
                connection.disconnect();
                if (responseCode == 200) {
                    System.out.println("上传成功");
                 } else {
                    System.out.println("上传失败");
                 }
}
Python
#!/usr/bin/env python

import requests

url = '<第一步接口获取的resourceUrl>'
headers = <第一步接口返回的headers>
result = requests.put(url, data=open('<path_to_file>', 'rb'), headers=headers)
print(result)
C#
public static string HttpRequest(string url, string filePath, Dictionary<string, string> headers) {

    FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read, FileShare.Read);
    BinaryReader reader = new BinaryReader(fileStream);
    reader.BaseStream.Seek(0, SeekOrigin.Begin);
    byte[] datas = reader.ReadBytes((int)reader.BaseStream.Length);
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    request.Method = "PUT";
    request.Timeout = 150000;
    foreach (var header in headers) {
        request.Headers.Add($"{header.Key}", $"{header.Value}");
    }
    Stream requestStream = null;
    string responseStr = null;
    try {
        if (datas != null) {
            request.ContentLength = datas.Length;
            requestStream = request.GetRequestStream();
            requestStream.Write(datas, 0, datas.Length);
            requestStream.Close();
        } else {
            request.ContentLength = 0;
        }
        HttpWebResponse response = request.GetResponse() as HttpWebResponse;
        responseStr = response.Headers.GetValues("x-oss-request-id")[0];
    } catch (Exception ex) {
        Console.WriteLine("error");
    } finally {
        request = null;
        requestStream = null;
    }
    return responseStr;
}
PHP
$url = $result->body->headerSignatureInfo->resourceUrls[0];
$headersSource = $result->body->headerSignatureInfo->headers;
foreach ($headersSource as $key => $value) {
$headers[] = $key . ': ' . $value;
}
// 需要主动指定content-type为空
$headers['Content-Type'] = '';

$file = '/Users/dengxian.ldx/Desktop/test.txt';

$ch = curl_init();
curl_setopt_array($ch, array(
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HEADER => true,
CURLOPT_TIMEOUT => 100,
CURLOPT_CONNECTTIMEOUT => 100,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_PUT => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
));
curl_setopt($ch, CURLOPT_INFILE, fopen($file , 'rb'));
curl_setopt($ch, CURLOPT_INFILESIZE, filesize($file) );
curl_setopt($ch, CURLOPT_UPLOAD, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response .PHP_EOL;
Node.js
const fs = require('fs');
const request = require('request-promise');

url = <url>;
header = <headers>;

// 注意: 需要主动指定content-type为空
headers['content-type']='';

var options = {
  method: 'PUT',
  url: url,
  headers: headers
};

fs.createReadStream('/Users/dengxian.ldx/temp/test/a.txt').pipe(request(options)).then(body =>{
  console.log(body);
}).catch(err => {
  console.log(err);
});
步骤三:调用本接口提交文件,完成文件上传。

说明

  • 存储空间类型为USER时,空间拥有权限的用户都有操作权限,其他员工调用添加权限接口进行授权。
  • 存储空间类型为APP时,任何人操作都需要调用添加权限接口进行授权。

请求

基本信息

字段
HTTP URLhttps://api.dingtalk.io/v2.0/storage/spaces/files/{parentDentryUuid}/commit
HTTP MethodPOST
支持的应用类型appType-企业内部应用 appType-第三方企业应用
权限要求permission-Storage.File.Write-企业存储文件写权限

请求头

名称类型是否必填描述
x-acs-dingtalk-access-tokenString调用该接口的访问凭证,通过以下获取: - 企业内部应用,调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用,调用获取第三方应用授权企业的accessToken接口获取。

路径参数

名称类型是否必填描述
parentDentryUuidString父节点dentryUuid,可调用搜索文件获取 dentryUuid 信息接口,获取返回参数dentryUuid字段。 如果是空间根目录,填空间根目录的dentryUuid。

查询参数

名称类型是否必填描述
unionIdString用户unionId,可调用查询用户详情接口获取。

请求体

名称类型是否必填描述
uploadKeyString添加文件唯一标识,调用获取文件上传信息接口获取uploadKey参数值。
nameString文件的名称,带后缀。命名有以下要求:- 头尾不能包含空格,否则会自动去除 - 不能包含特殊字符,包括:制表符、*"<>、`- 不能以.` 结尾
optionObject可选参数。
sizeLong默认文件大小, 单位:Byte。 如果此字段不为空,企业存储系统会校验文件实际大小是否和此字段是否一致,不一致会报错。
conflictStrategyString文件名称冲突策略。 - AUTO_RENAME:自动重命名,默认值 - OVERWRITE:覆盖 - RETURN_DENTRY_IF_EXISTS:返回已存在文件 - RETURN_ERROR_IF_EXISTS:文件已存在时报错
appPropertiesArray当前文件的应用属性列表,最大值3。
nameString属性名称。 该属性名称在当前app下需要保证唯一,不同app间同名属性互不影响。
valueString属性值。
visibilityString属性可见性。 - PUBLIC:所有应用都可见 - PRIVATE:仅限当前应用可见
convertToOnlineDocBoolean是否转换成在线文档。 - false(默认值):否 - true:是

请求示例

HTTP
POST /v2.0/storage/spaces/files/uuid/commit?unionId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "uploadKey" : "upload_key",
  "name" : "dentry_name",
  "option" : {
    "size" : 512,
    "conflictStrategy" : "AUTO_RENAME",
    "appProperties" : [ {
      "name" : "property_name",
      "value" : "property_value",
      "visibility" : "PRIVATE"
    } ],
    "convertToOnlineDoc" : false
  }
}
Java
// 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_2_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_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkstorage_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_2_0.models.CommitFileHeaders commitFileHeaders = new com.aliyun.dingtalkstorage_2_0.models.CommitFileHeaders();
        commitFileHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest.CommitFileRequestOptionAppProperties optionAppProperties0 = new com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest.CommitFileRequestOptionAppProperties()
                .setName("property_name")
                .setValue("property_value")
                .setVisibility("PRIVATE");
        com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest.CommitFileRequestOption option = new com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest.CommitFileRequestOption()
                .setSize(512L)
                .setConflictStrategy("AUTO_RENAME")
                .setAppProperties(java.util.Arrays.asList(
                    optionAppProperties0
                ))
                .setConvertToOnlineDoc(false);
        com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest commitFileRequest = new com.aliyun.dingtalkstorage_2_0.models.CommitFileRequest()
                .setUnionId("union_id")
                .setUploadKey("upload_key")
                .setName("dentry_name")
                .setOption(option);
        try {
            client.commitFileWithOptions("uuid", commitFileRequest, commitFileHeaders, 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 属性,可帮助开发定位问题
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.storage_2_0.client import Client as dingtalkstorage_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_2_0 import models as dingtalkstorage__2__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_2_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        commit_file_headers = dingtalkstorage__2__0_models.CommitFileHeaders()
        commit_file_headers.x_acs_dingtalk_access_token = '<your access token>'
        option_app_properties_0 = dingtalkstorage__2__0_models.CommitFileRequestOptionAppProperties(
            name='property_name',
            value='property_value',
            visibility='PRIVATE'
        )
        option = dingtalkstorage__2__0_models.CommitFileRequestOption(
            size=512,
            conflict_strategy='AUTO_RENAME',
            app_properties=[
                option_app_properties_0
            ],
            convert_to_online_doc=False
        )
        commit_file_request = dingtalkstorage__2__0_models.CommitFileRequest(
            union_id='union_id',
            upload_key='upload_key',
            name='dentry_name',
            option=option
        )
        try:
            client.commit_file_with_options('uuid', commit_file_request, commit_file_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()
        commit_file_headers = dingtalkstorage__2__0_models.CommitFileHeaders()
        commit_file_headers.x_acs_dingtalk_access_token = '<your access token>'
        option_app_properties_0 = dingtalkstorage__2__0_models.CommitFileRequestOptionAppProperties(
            name='property_name',
            value='property_value',
            visibility='PRIVATE'
        )
        option = dingtalkstorage__2__0_models.CommitFileRequestOption(
            size=512,
            conflict_strategy='AUTO_RENAME',
            app_properties=[
                option_app_properties_0
            ],
            convert_to_online_doc=False
        )
        commit_file_request = dingtalkstorage__2__0_models.CommitFileRequest(
            union_id='union_id',
            upload_key='upload_key',
            name='dentry_name',
            option=option
        )
        try:
            await client.commit_file_with_options_async('uuid', commit_file_request, commit_file_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
<?php

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

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

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\CommitFileHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\CommitFileRequest\option\appProperties;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\CommitFileRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\CommitFileRequest;
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();
        $commitFileHeaders = new CommitFileHeaders([]);
        $commitFileHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $optionAppProperties0 = new appProperties([
            "name" => "property_name",
            "value" => "property_value",
            "visibility" => "PRIVATE"
        ]);
        $option = new option([
            "size" => 512,
            "conflictStrategy" => "AUTO_RENAME",
            "appProperties" => [
                $optionAppProperties0
            ],
            "convertToOnlineDoc" => false
        ]);
        $commitFileRequest = new CommitFileRequest([
            "unionId" => "union_id",
            "uploadKey" => "upload_key",
            "name" => "dentry_name",
            "option" => $option
        ]);
        try {
            $client->commitFileWithOptions("uuid", $commitFileRequest, $commitFileHeaders, 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));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkstorage_2_0  "github.com/alibabacloud-go/dingtalk/storage_2_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_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkstorage_2_0.Client{}
  _result, _err = dingtalkstorage_2_0.NewClient(config)
  return _result, _err
}

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

  commitFileHeaders := &dingtalkstorage_2_0.CommitFileHeaders{}
  commitFileHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  optionAppProperties0 := &dingtalkstorage_2_0.CommitFileRequestOptionAppProperties{
    Name: tea.String("property_name"),
    Value: tea.String("property_value"),
    Visibility: tea.String("PRIVATE"),
  }
  option := &dingtalkstorage_2_0.CommitFileRequestOption{
    Size: tea.Int64(512),
    ConflictStrategy: tea.String("AUTO_RENAME"),
    AppProperties: []*dingtalkstorage_2_0.CommitFileRequestOptionAppProperties{optionAppProperties0},
    ConvertToOnlineDoc: tea.Bool(false),
  }
  commitFileRequest := &dingtalkstorage_2_0.CommitFileRequest{
    UnionId: tea.String("union_id"),
    UploadKey: tea.String("upload_key"),
    Name: tea.String("dentry_name"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CommitFileWithOptions(tea.String("uuid"), commitFileRequest, commitFileHeaders, &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)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_2_0, * as $dingtalkstorage_2_0 from '@alicloud/dingtalk/storage_2_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_2_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkstorage_2_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let commitFileHeaders = new $dingtalkstorage_2_0.CommitFileHeaders({ });
    commitFileHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let optionAppProperties0 = new $dingtalkstorage_2_0.CommitFileRequestOptionAppProperties({
      name: "property_name",
      value: "property_value",
      visibility: "PRIVATE",
    });
    let option = new $dingtalkstorage_2_0.CommitFileRequestOption({
      size: 512,
      conflictStrategy: "AUTO_RENAME",
      appProperties: [
        optionAppProperties0
      ],
      convertToOnlineDoc: false,
    });
    let commitFileRequest = new $dingtalkstorage_2_0.CommitFileRequest({
      unionId: "union_id",
      uploadKey: "upload_key",
      name: "dentry_name",
      option: option,
    });
    try {
      await client.commitFileWithOptions("uuid", commitFileRequest, commitFileHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性,可帮助开发定位问题
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileHeaders commitFileHeaders = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileHeaders();
            commitFileHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest.CommitFileRequestOption.CommitFileRequestOptionAppProperties optionAppProperties0 = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest.CommitFileRequestOption.CommitFileRequestOptionAppProperties
            {
                Name = "property_name",
                Value = "property_value",
                Visibility = "PRIVATE",
            };
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest.CommitFileRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest.CommitFileRequestOption
            {
                Size = 512,
                ConflictStrategy = "AUTO_RENAME",
                AppProperties = new List<AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest.CommitFileRequestOption.CommitFileRequestOptionAppProperties>
                {
                    optionAppProperties0
                },
                ConvertToOnlineDoc = false,
            };
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest commitFileRequest = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.CommitFileRequest
            {
                UnionId = "union_id",
                UploadKey = "upload_key",
                Name = "dentry_name",
                Option = option,
            };
            try
            {
                client.CommitFileWithOptions("uuid", commitFileRequest, commitFileHeaders, 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 属性,可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称类型描述
dentryObject文件信息。
idString文件id。
spaceIdString所在空间id。
parentIdString父目录Id。根目录时,该参数是0。 空值代表根目录的parentId不存在。
typeString类型,目录或文件,枚举值: - FILE:文件 - FOLDER:文件夹
nameString文件名称。
sizeLong文件大小, 单位:Byte。
pathString文件在空间内的路径。
versionLong版本。
statusString状态: - NORMAL:正常 - DELETED:已删除 - EXPIRED:已过期
extensionString文件后缀。
creatorIdString创建者unionId。
modifierIdString修改者unionId。
createTimeString创建时间,iso8601格式,例如:2022-07-29T14:55Z。
modifiedTimeString修改时间,iso8601格式,例如:2022-07-29T14:55Z。
propertiesObject文件属性。
readOnlyBoolean文件是否只读。 - true:是 - false:否
appPropertiesMap<String, Array>在特定应用上的属性。key是所属空间的ownerId,value是属性列表。
Array属性列表。
nameString属性名称。
valueString属性值。
visibilityString属性可见性。 - PUBLIC:所有应用都可见 - PRIVATE:仅限当前应用可见
uuidString唯一标识uuid,如移动文件,此字段不变。
partitionTypeString存储分区: - PUBLIC_OSS_PARTITION:公有云OSS存储分区 - MINI_OSS_PARTITION:专属MiniOSS存储分区
storageDriverString驱动类型,枚举值: - DINGTALK:钉钉统一存储驱动 - ALIDOC:钉钉文档存储驱动 - SHANJI:闪记存储驱动 - UNKNOWN:未知驱动
thumbnailObject缩略图信息。
widthInteger缩略图宽度。
heightInteger缩略图高度。
urlString缩略图url。
categoryString类别,枚举值: - IMAGE:图片 - VIDEO:视频 - AUDIO:音频 - ARCHIVE:压缩包 - SHORTCUT:快捷方式 - DOCUMENT:文档 - ALI_DOC:钉钉文档 - OTHER:其它

响应体示例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "dentry" : {
    "id" : "dentry_id",
    "spaceId" : "space_id",
    "parentId" : "parent_id",
    "type" : "FILE",
    "name" : "dentry_name",
    "size" : 512,
    "path" : "dentry_path",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "txt",
    "creatorId" : "creator_id",
    "modifierId" : "modifier_id",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "property_name",
      "value" : "property_value",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    },
    "category" : "DOCUMENT"
  }
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
HttpCode错误码错误信息说明
400operationConcurrentControl%s并发控制
400paramError%s参数错误
400paramError.parentDentryUuid%s参数错误-parentDentryUuid
400paramError.uploadKey%s参数错误-uploadKey
400paramError.name%s参数错误-name
400paramError.conflictStrategy%s参数错误-conflictStrategy
400spaceQuotaInsufficient%s空间容量不足
400sceneQuotaInsufficient%s场景容量不足
400appQuotaInsufficient%s应用容量不足
400orgQuotaInsufficient%s企业容量不足
400dentryNameIllegal%s文件名非法
400dentryStoreError%s文件存储异常
400dentryNameConflict%s文件名冲突
400dentryFormatNotSupport%s不支持的文件格式
403permissionDenied%s用户缺少上传文件的权限
404spaceNotExist%s空间不存在
500systemError%s系统错误
500unknownErrorUnknown Error未知错误
503operationTimeout%s请求超时