Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/listAll |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Internal app appType-Third-party enterprise app |
| Izin yang diperlukan | permission-Storage.File.Read-Izin baca untuk file penyimpanan organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Memperoleh access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Memperoleh access token organisasi yang diberi otorisasi untuk aplikasi pihak ketiga. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Menambahkan ruang dan gunakan nilai parameter id yang dikembalikan. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId dari operator. Panggil API Mengueri detail pengguna untuk memperolehnya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| option | Object | Tidak | Parameter opsional. |
| nextToken | String | Tidak | Cursor paginasi. - Untuk panggilan pertama, jangan sertakan parameter ini. - Untuk panggilan berikutnya, sertakan nextToken yang dikembalikan pada panggilan sebelumnya. |
| maxResults | Integer | Tidak | Jumlah entri per halaman. Default: 50. Maksimum: 50. |
| order | String | Tidak | Aturan pengurutan. Saat ini hanya pengurutan berdasarkan waktu modifikasi yang didukung. - ASC (default): urutan menaik - DESC: urutan menurun - Saat mengurutkan menaik, jika file berubah selama paginasi, data duplikat mungkin diambil. - Saat mengurutkan menurun, jika file berubah selama paginasi, data mungkin hilang. |
| withThumbnail | Boolean | Tidak | Apakah akan mengambil tautan thumbnail file. - true: Ya - false (default): Tidak Ambil sesuai kebutuhan. Mengambil thumbnail meningkatkan waktu respons API. |
Contoh permintaan
HTTPPOST /v1.0/storage/spaces/897xxxxx/dentries/listAll?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"option" : {
"nextToken" : "3678056xxxxx",
"maxResults" : 30,
"order" : "DESC",
"withThumbnail" : true
}
}
// 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 a 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.ListAllDentriesHeaders listAllDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesHeaders();
listAllDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest.ListAllDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest.ListAllDentriesRequestOption()
.setNextToken("3678056xxxxx")
.setMaxResults(30)
.setOrder("DESC")
.setWithThumbnail(true);
com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest listAllDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.ListAllDentriesRequest()
.setUnionId("chyxxxxx")
.setOption(option);
try {
client.listAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, 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 to 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 to 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 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_all_dentries_headers = dingtalkstorage__1__0_models.ListAllDentriesHeaders()
list_all_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.ListAllDentriesRequestOption(
next_token='3678056xxxxx',
max_results=30,
order='DESC',
with_thumbnail=True
)
list_all_dentries_request = dingtalkstorage__1__0_models.ListAllDentriesRequest(
union_id='chyxxxxx',
option=option
)
try:
client.list_all_dentries_with_options('897xxxxx', list_all_dentries_request, list_all_dentries_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 to help locate issues
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_all_dentries_headers = dingtalkstorage__1__0_models.ListAllDentriesHeaders()
list_all_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.ListAllDentriesRequestOption(
next_token='3678056xxxxx',
max_results=30,
order='DESC',
with_thumbnail=True
)
list_all_dentries_request = dingtalkstorage__1__0_models.ListAllDentriesRequest(
union_id='chyxxxxx',
option=option
)
try:
await client.list_all_dentries_with_options_async('897xxxxx', list_all_dentries_request, list_all_dentries_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 to 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\ListAllDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListAllDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListAllDentriesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$listAllDentriesHeaders = new ListAllDentriesHeaders([]);
$listAllDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
$option = new option([
"nextToken" => "3678056xxxxx",
"maxResults" => 30,
"order" => "DESC",
"withThumbnail" => true
]);
$listAllDentriesRequest = new ListAllDentriesRequest([
"unionId" => "chyxxxxx",
"option" => $option
]);
try {
$client->listAllDentriesWithOptions("897xxxxx", $listAllDentriesRequest, $listAllDentriesHeaders, 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 to 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 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
}
listAllDentriesHeaders := &dingtalkstorage_1_0.ListAllDentriesHeaders{}
listAllDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
option := &dingtalkstorage_1_0.ListAllDentriesRequestOption{
NextToken: tea.String("3678056xxxxx"),
MaxResults: tea.Int32(30),
Order: tea.String("DESC"),
WithThumbnail: tea.Bool(true),
}
listAllDentriesRequest := &dingtalkstorage_1_0.ListAllDentriesRequest{
UnionId: tea.String("chyxxxxx"),
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListAllDentriesWithOptions(tea.String("897xxxxx"), listAllDentriesRequest, listAllDentriesHeaders, &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 to 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 a 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 listAllDentriesHeaders = new $dingtalkstorage_1_0.ListAllDentriesHeaders({ });
listAllDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
let option = new $dingtalkstorage_1_0.ListAllDentriesRequestOption({
nextToken: "3678056xxxxx",
maxResults: 30,
order: "DESC",
withThumbnail: true,
});
let listAllDentriesRequest = new $dingtalkstorage_1_0.ListAllDentriesRequest({
unionId: "chyxxxxx",
option: option,
});
try {
await client.listAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message properties to 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 a 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.ListAllDentriesHeaders listAllDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesHeaders();
listAllDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest.ListAllDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest.ListAllDentriesRequestOption
{
NextToken = "3678056xxxxx",
MaxResults = 30,
Order = "DESC",
WithThumbnail = true,
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest listAllDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListAllDentriesRequest
{
UnionId = "chyxxxxx",
Option = option,
};
try
{
client.ListAllDentriesWithOptions("897xxxxx", listAllDentriesRequest, listAllDentriesHeaders, 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 to 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 to help locate issues
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| dentries | Array | Daftar file atau folder yang dikembalikan. |
| id | String | ID file atau folder. |
| spaceId | String | ID ruang tempat file atau folder berada. |
| parentId | String | ID folder induk. ID folder root adalah 0. |
| type | String | Tipe. - FILE: file - FOLDER: folder |
| name | String | Nama file atau folder. |
| size | Long | Ukuran file, dalam byte. |
| path | String | Jalur file atau folder. |
| version | Long | Versi file. |
| status | String | Status file atau folder. - NORMAL: normal - DELETED: dihapus - EXPIRED: kedaluwarsa |
| extension | String | Ekstensi file. |
| creatorId | String | unionId dari pembuat. |
| modifierId | String | unionId dari pengubah. |
| createTime | String | Waktu pembuatan, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| modifiedTime | String | Waktu modifikasi, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| properties | Object | Atribut file. |
| readOnly | Boolean | Apakah file hanya baca. - true: Ya - false: Tidak |
| appProperties | Map<String, Array> | Atribut untuk aplikasi tertentu. |
| Array | Daftar atribut ruang. | |
| name | String | Nama atribut. |
| value | String | Nilai atribut. |
| visibility | String | Visibilitas atribut. - PUBLIC: terlihat oleh semua aplikasi - PRIVATE: hanya terlihat oleh aplikasi saat ini |
| uuid | String | Bidang pengidentifikasi. |
| partitionType | String | Partisi penyimpanan. - PUBLIC_OSS_PARTITION: partisi penyimpanan OSS cloud publik - MINI_OSS_PARTITION: partisi penyimpanan Mini OSS khusus |
| storageDriver | String | Tipe driver. - DINGTALK: driver penyimpanan terpadu DingTalk - ALIDOC: driver penyimpanan DingTalk Docs - SHANJI: driver penyimpanan Flash Note - UNKNOWN: driver tidak dikenal |
| thumbnail | Object | Informasi thumbnail. Dikembalikan hanya ketika parameter withThumbnail diatur ke true. |
| width | Integer | Lebar thumbnail, dalam px. |
| height | Integer | Tinggi thumbnail, dalam px. |
| url | String | URL thumbnail. |
| nextToken | String | Cursor paginasi. Jika parameter ini tidak kosong, ada lebih banyak data yang tersedia. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"dentries" : [ {
"id" : "677xxxxx",
"spaceId" : "789xxxxx",
"parentId" : "766xxxxx",
"type" : "FILE",
"name" : "Folder uji",
"size" : 512,
"path" : "./Folder uji",
"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" : "Atribut 1",
"value" : "Nilai 1",
"visibility" : "PRIVATE"
} ],
"uuid" : "123xxxxx",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK",
"thumbnail" : {
"width" : 64,
"height" : 64,
"url" : "url"
}
} ],
"nextToken" : "8965000xxxxx"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global untuk solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk mengambil daftar file |
| 404 | spaceNotExist | %s | Ruang tidak ada |
| 404 | dentryNotExist | %s | File tidak ada |
| 500 | systemError | %s | Error sistem |
| 500 | unknownError | Unknown Error | Error tidak dikenal |
| 503 | operationTimeout | %s | Permintaan habis waktu |