接口调用说明
在存储空间内调用提交文件接口时,如果文件名策略使用的是OVERWRITE,当出现上传同名文件时,该文件会产生历史版本。
请求
基本信息
| 字段 | 值 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/versions |
| HTTP Method | GET |
| 支持的应用类型 | appType-企业内部应用 appType-第三方企业应用 |
| 权限要求 | permission-Storage.File.Read-企业存储文件读权限 |
请求头
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证,通过以下获取: - 企业内部应用,调用获取企业内部应用的accessToken接口获取。 - 第三方企业应用,调用获取第三方应用授权企业的accessToken接口获取。 |
路径参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| spaceId | String | 是 | 空间Id,可调用添加空间接口获取id参数值。 |
| dentryId | String | 是 | 文件Id,可调用获取文件或文件夹列表或根据dentryUuid获取spaceId和dentryId接口获取id参数值。 |
查询参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| nextToken | String | 否 | 分页游标。 - 如果是首次查询,该参数不传。 - 如果是非首次查询,该参数传上次调用时返回的nextToken。 |
| maxResults | Integer | 否 | 每页条目数,默认100,最大100。 |
| unionId | String | 是 | 操作者unionId,可调用查询用户详情接口获取unionid参数值。 |
请求示例
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>使用 Token 初始化账号Client</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 中含有 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 属性,可帮助开发定位问题
}
}
}
}
# -*- 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:
"""
使用 Token 初始化账号Client
@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 中含有 code 和 message 属性,可帮助开发定位问题
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 中含有 code 和 message 属性,可帮助开发定位问题
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 {
/**
* 使用 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();
$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 中含有 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));
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:
//
// 使用 Token 初始化账号Client
//
// @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
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 {
/**
* 使用 Token 初始化账号Client
* @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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
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>使用 Token 初始化账号Client</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 中含有 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 属性,可帮助开发定位问题
}
}
}
}
}
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| dentries | Array | 文件版本列表。 |
| id | String | 文件id。 |
| spaceId | String | 所在空间Id。 |
| parentId | String | 父目录Id。根目录时,该参数是0。 |
| type | String | 类型: - FILE:文件 |
| name | String | 文件名称。 |
| size | Long | 文件大小,单位Byte。 |
| path | String | 文件路径。 |
| version | Long | 版本。 |
| status | String | 状态: - NORMAL:正常 - DELETED:已删除 - EXPIRED:已过期 |
| extension | String | 文件后缀。 |
| creatorId | String | 创建者unionId。 |
| modifierId | String | 修改者unionId。 |
| createTime | String | 创建时间,iso8601格式,例如:2022-07-29T14:55Z。 |
| modifiedTime | String | 修改时间,iso8601格式,例如:2022-07-29T14:55Z。 |
| properties | Object | 属性列表。 |
| readOnly | Boolean | 文件是否只读: - true:是 - false:否 |
| appProperties | Map<String, Array> | 在特定应用上的属性。 |
| Array | 属性列表。 | |
| name | String | 属性名。 |
| value | String | 属性值。 |
| visibility | String | 属性可见性: - PUBLIC:所有空间可见 - PRIVATE:当前空间可见 |
| uuid | String | 业务标识。 |
| partitionType | String | 存储分区: - PUBLIC_OSS_PARTITION:公有云OSS存储分区 - MINI_OSS_PARTITION:专属MiniOSS存储分区 |
| storageDriver | String | 驱动类型: - DINGTALK:钉钉统一存储驱动 - ALIDOC:钉钉文档存储驱动 - UNKNOWN:未知驱动 |
| nextToken | String | 分页游标。 该字段不为空,表示有更多数据。 |
响应体示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"dentries" : [ {
"id" : "668xxxxx",
"spaceId" : "854xxxxx",
"parentId" : "0",
"type" : "FILE",
"name" : "测试文件.txt",
"size" : 512,
"path" : "/测试文件.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" : "属性名1",
"value" : "属性值1",
"visibility" : "PRIVATE"
} ],
"uuid" : "uuid",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK"
} ],
"nextToken" : "next_token"
}
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | operationConcurrentControl | %s | 稍后重试 |
| 400 | paramError | %s | 参数错误 |
| 400 | paramError.spaceId | %s | 参数错误-spaceId |
| 400 | paramError.parentId | %s | 参数错误-parentId |
| 400 | paramError.maxResults | %s | 参数错误-maxResults |
| 403 | permissionDenied | %s | 用户缺少获取文件(夹)信息的权限 |
| 500 | systemError | %s | 系统错误 |
| 500 | unknownError | Unknown Error | 未知错误 |
| 503 | operationTimeout | %s | 请求超时 |