API call description
When you call the Submit file API in a storage space, if the file name policy is set toOVERWRITE, uploading a file with the same name generates a historical version of the file.
Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/versions |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permission requirements | permission-Storage.File.Read-Organization storage file read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of a third-party app’s authorized enterprise API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| spaceId | String | Yes | The space ID. Call the Add space API to get the value of the id parameter. |
| dentryId | String | Yes | The file ID. Call the Get a list of files or folders or Get spaceId and dentryId by dentryUuid API to get the value of the id parameter. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| nextToken | String | No | The pagination cursor. - For the first query, leave this parameter empty. - For subsequent queries, pass the nextToken returned by the previous call. |
| maxResults | Integer | No | The number of entries per page. Default: 100. Maximum: 100. |
| unionId | String | Yes | The unionId of the operator. Call the Query user details API to get the value of the unionid parameter. |
Request example
HTTPGET /v1.0/storage/spaces/854xxxxx/dentries/668xxxxx/versions?nextToken=next_token&maxResults=30&unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with a token</p>
* @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 {
com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkstorage_1_0.models.ListDentryVersionsHeaders listDentryVersionsHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListDentryVersionsHeaders();
listDentryVersionsHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.ListDentryVersionsRequest listDentryVersionsRequest = new com.aliyun.dingtalkstorage_1_0.models.ListDentryVersionsRequest()
.setNextToken("next_token")
.setMaxResults(30)
.setUnionId("chyxxxxx");
try {
client.listDentryVersionsWithOptions("854xxxxx", "668xxxxx", listDentryVersionsRequest, listDentryVersionsHeaders, 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 attributes to help locate the issue
}
} 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 attributes to help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json
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 with a 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()
list_dentry_versions_headers = dingtalkstorage__1__0_models.ListDentryVersionsHeaders()
list_dentry_versions_headers.x_acs_dingtalk_access_token = '<your access token>'
list_dentry_versions_request = dingtalkstorage__1__0_models.ListDentryVersionsRequest(
next_token='next_token',
max_results=30,
union_id='chyxxxxx'
)
try:
client.list_dentry_versions_with_options('854xxxxx', '668xxxxx', list_dentry_versions_request, list_dentry_versions_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 attributes to help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_dentry_versions_headers = dingtalkstorage__1__0_models.ListDentryVersionsHeaders()
list_dentry_versions_headers.x_acs_dingtalk_access_token = '<your access token>'
list_dentry_versions_request = dingtalkstorage__1__0_models.ListDentryVersionsRequest(
next_token='next_token',
max_results=30,
union_id='chyxxxxx'
)
try:
await client.list_dentry_versions_with_options_async('854xxxxx', '668xxxxx', list_dentry_versions_request, list_dentry_versions_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 attributes to help locate the issue
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\ListDentryVersionsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListDentryVersionsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a 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();
$listDentryVersionsHeaders = new ListDentryVersionsHeaders([]);
$listDentryVersionsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$listDentryVersionsRequest = new ListDentryVersionsRequest([
"nextToken" => "next_token",
"maxResults" => 30,
"unionId" => "chyxxxxx"
]);
try {
$client->listDentryVersionsWithOptions("854xxxxx", "668xxxxx", $listDentryVersionsRequest, $listDentryVersionsHeaders, 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 attributes to help locate the issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
package main
import (
"encoding/json"
"strings"
"fmt"
"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"
)
// Description:
//
// Initialize the account Client with a 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
}
listDentryVersionsHeaders := &dingtalkstorage_1_0.ListDentryVersionsHeaders{}
listDentryVersionsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
listDentryVersionsRequest := &dingtalkstorage_1_0.ListDentryVersionsRequest{
NextToken: tea.String("next_token"),
MaxResults: tea.Int32(30),
UnionId: tea.String("chyxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListDentryVersionsWithOptions(tea.String("854xxxxx"), tea.String("668xxxxx"), listDentryVersionsRequest, listDentryVersionsHeaders, &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 attributes to help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');
class Client {
/**
* Initialize the account Client with a token
* @return Client
* @throws Exception
*/
static createClient() {
let config = new OpenApi.Config({ });
config.protocol = 'https';
config.regionId = 'central';
return new dingtalkstorage_1_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let listDentryVersionsHeaders = new dingtalkstorage_1_0.ListDentryVersionsHeaders({ });
listDentryVersionsHeaders.xAcsDingtalkAccessToken = '<your access token>';
let listDentryVersionsRequest = new dingtalkstorage_1_0.ListDentryVersionsRequest({
nextToken: 'next_token',
maxResults: 30,
unionId: 'chyxxxxx',
});
try {
await client.listDentryVersionsWithOptions('854xxxxx', '668xxxxx', listDentryVersionsRequest, listDentryVersionsHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err contains code and message attributes to help locate the issue
}
}
}
}
exports.Client = Client;
Client.main(process.argv.slice(2));
using Newtonsoft.Json;
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
{
/// <term><b>Description:</b></term>
/// <description>
/// <para>Initialize the account Client with a token</para>
/// </description>
///
/// <returns>
/// Client
/// </returns>
///
/// <term><b>Exception:</b></term>
/// 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.ListDentryVersionsHeaders listDentryVersionsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentryVersionsHeaders();
listDentryVersionsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentryVersionsRequest listDentryVersionsRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentryVersionsRequest
{
NextToken = "next_token",
MaxResults = 30,
UnionId = "chyxxxxx",
};
try
{
client.ListDentryVersionsWithOptions("854xxxxx", "668xxxxx", listDentryVersionsRequest, listDentryVersionsHeaders, 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 attributes to help locate the issue
}
}
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 attributes to help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| dentries | Array | The file version list. |
| id | String | The file ID. |
| spaceId | String | The ID of the space the file belongs to. |
| parentId | String | The parent directory ID. For the root directory, this parameter is 0. |
| type | String | The type: - FILE: file |
| name | String | The file name. |
| size | Long | The file size, in bytes. |
| path | String | The file path. |
| version | Long | The version. |
| status | String | The status: - NORMAL: normal - DELETED: deleted - EXPIRED: expired |
| extension | String | The file extension. |
| creatorId | String | The unionId of the creator. |
| modifierId | String | The unionId of the modifier. |
| createTime | String | The created time in ISO 8601 format. Example: 2022-07-29T14:55Z. |
| modifiedTime | String | The modified time in ISO 8601 format. Example: 2022-07-29T14:55Z. |
| properties | Object | The attribute list. |
| readOnly | Boolean | Whether the file is read-only: - true: yes - false: no |
| appProperties | Map<String, Array> | The attributes for a specific app. |
| Array | The attribute list. | |
| name | String | The attribute name. |
| value | String | The attribute value. |
| visibility | String | The attribute visibility: - PUBLIC: visible to all spaces - PRIVATE: visible only to the current space |
| uuid | String | The business identifier. |
| partitionType | String | The storage partition: - PUBLIC_OSS_PARTITION: public cloud OSS storage partition - MINI_OSS_PARTITION: dedicated MiniOSS storage partition |
| storageDriver | String | The driver type: - DINGTALK: DingTalk unified storage driver - ALIDOC: DingTalk Docs storage driver - UNKNOWN: unknown driver |
| nextToken | String | The pagination cursor. If this field is not empty, more data is available. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"dentries" : [ {
"id" : "668xxxxx",
"spaceId" : "854xxxxx",
"parentId" : "0",
"type" : "FILE",
"name" : "test_file.txt",
"size" : 512,
"path" : "/test_file.txt",
"version" : 1,
"status" : "NORMAL",
"extension" : "txt",
"creatorId" : "chyxxxxx",
"modifierId" : "chyxxxxx",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z",
"properties" : {
"readOnly" : true
},
"appProperties" : [ {
"name" : "propertyName1",
"value" : "propertyValue1",
"visibility" : "PRIVATE"
} ],
"uuid" : "uuid",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK"
} ],
"nextToken" : "next_token"
}
Error codes
If an error occurs when you call this API, refer to the Global error codes document for the solution based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | operationConcurrentControl | %s | Try again later. |
| 400 | paramError | %s | Parameter error. |
| 400 | paramError.spaceId | %s | Parameter error - spaceId. |
| 400 | paramError.parentId | %s | Parameter error - parentId. |
| 400 | paramError.maxResults | %s | Parameter error - maxResults. |
| 403 | permissionDenied | %s | The user does not have permission to get file (folder) information. |
| 500 | systemError | %s | System error. |
| 500 | unknownError | Unknown Error | Unknown error. |
| 503 | operationTimeout | %s | Request timed out. |