Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries |
| Metode HTTP | GET |
| Tipe aplikasi yang didukung | appType-Internal app appType-Third-party enterprise app |
| Izin yang diperlukan | permission-Storage.File.Read-Read permission for enterprise storage files |
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 Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token perusahaan yang mengotorisasi aplikasi pihak ketiga. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Menambahkan ruang untuk mendapatkan nilai parameter id. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| parentId | String | Ya | ID direktori induk. Untuk direktori root, setel parameter ini ke 0. Panggil API Mendapatkan daftar file atau folder untuk mendapatkan nilai parameter parentId. |
| nextToken | String | Tidak | Cursor paginasi. - Kosongkan parameter ini untuk panggilan pertama. - Untuk panggilan berikutnya, teruskan nextToken yang dikembalikan oleh panggilan sebelumnya. |
| maxResults | Integer | Tidak | Jumlah entri per halaman. Nilai maksimum adalah 50. |
| orderBy | String | Tidak | Bidang pengurutan. - MODIFIED_TIME: waktu modifikasi terakhir. Nilai default. - CREATE_TIME: waktu pembuatan. - NAME: nama. - SIZE: ukuran. |
| order | String | Tidak | Aturan pengurutan. - ASC: urutan menaik. - DESC: urutan menurun. Nilai default. |
| withThumbnail | Boolean | Tidak | Apakah akan mendapatkan tautan sementara thumbnail file. Dapatkan sesuai kebutuhan karena hal ini memengaruhi waktu respons API. - true: dapatkan. - false: jangan dapatkan. Nilai default. |
| unionId | String | Ya | unionId operator. Panggil API Meminta detail pengguna untuk mendapatkannya. |
Contoh permintaan
HTTPGET /v1.0/storage/spaces/854xxxxx/dentries?parentId=0&nextToken=next_token&maxResults=30&orderBy=MODIFIED_TIME&order=DESC&withThumbnail=false&unionId=cHtUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
// 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 with 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.ListDentriesHeaders listDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.ListDentriesHeaders();
listDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.ListDentriesRequest listDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.ListDentriesRequest()
.setParentId("0")
.setNextToken("next_token")
.setMaxResults(30)
.setOrderBy("MODIFIED_TIME")
.setOrder("DESC")
.setWithThumbnail(false)
.setUnionId("cHtUxxxxx");
try {
client.listDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains code and message attributes, which help diagnose 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)) {
// The err contains code and message attributes, which help diagnose the issue
}
}
}
}
# -*- 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 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_dentries_headers = dingtalkstorage__1__0_models.ListDentriesHeaders()
list_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
list_dentries_request = dingtalkstorage__1__0_models.ListDentriesRequest(
parent_id='0',
next_token='next_token',
max_results=30,
order_by='MODIFIED_TIME',
order='DESC',
with_thumbnail=False,
union_id='cHtUxxxxx'
)
try:
client.list_dentries_with_options('854xxxxx', list_dentries_request, list_dentries_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message attributes, which help diagnose the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_dentries_headers = dingtalkstorage__1__0_models.ListDentriesHeaders()
list_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
list_dentries_request = dingtalkstorage__1__0_models.ListDentriesRequest(
parent_id='0',
next_token='next_token',
max_results=30,
order_by='MODIFIED_TIME',
order='DESC',
with_thumbnail=False,
union_id='cHtUxxxxx'
)
try:
await client.list_dentries_with_options_async('854xxxxx', list_dentries_request, list_dentries_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message attributes, which help diagnose 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\ListDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\ListDentriesRequest;
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();
$listDentriesHeaders = new ListDentriesHeaders([]);
$listDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
$listDentriesRequest = new ListDentriesRequest([
"parentId" => "0",
"nextToken" => "next_token",
"maxResults" => 30,
"orderBy" => "MODIFIED_TIME",
"order" => "DESC",
"withThumbnail" => false,
"unionId" => "cHtUxxxxx"
]);
try {
$client->listDentriesWithOptions("854xxxxx", $listDentriesRequest, $listDentriesHeaders, 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)) {
// The err contains code and message attributes, which help diagnose 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));
// 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 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
}
listDentriesHeaders := &dingtalkstorage_1_0.ListDentriesHeaders{}
listDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
listDentriesRequest := &dingtalkstorage_1_0.ListDentriesRequest{
ParentId: tea.String("0"),
NextToken: tea.String("next_token"),
MaxResults: tea.Int32(30),
OrderBy: tea.String("MODIFIED_TIME"),
Order: tea.String("DESC"),
WithThumbnail: tea.Bool(false),
UnionId: tea.String("cHtUxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListDentriesWithOptions(tea.String("854xxxxx"), listDentriesRequest, listDentriesHeaders, &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)) {
// The err contains code and message attributes, which help diagnose the issue
}
}
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 with 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 listDentriesHeaders = new $dingtalkstorage_1_0.ListDentriesHeaders({ });
listDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
let listDentriesRequest = new $dingtalkstorage_1_0.ListDentriesRequest({
parentId: "0",
nextToken: "next_token",
maxResults: 30,
orderBy: "MODIFIED_TIME",
order: "DESC",
withThumbnail: false,
unionId: "cHtUxxxxx",
});
try {
await client.listDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err contains code and message attributes, which help diagnose the issue
}
}
}
}
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 with 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.ListDentriesHeaders listDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesHeaders();
listDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesRequest listDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.ListDentriesRequest
{
ParentId = "0",
NextToken = "next_token",
MaxResults = 30,
OrderBy = "MODIFIED_TIME",
Order = "DESC",
WithThumbnail = false,
UnionId = "cHtUxxxxx",
};
try
{
client.ListDentriesWithOptions("854xxxxx", listDentriesRequest, listDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains code and message attributes, which help diagnose 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))
{
// The err contains code and message attributes, which help diagnose the issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| dentries | Array | Daftar file atau folder. |
| id | String | ID file atau folder. |
| spaceId | String | ID ruang tempat file atau folder berada. |
| parentId | String | ID direktori induk. Untuk direktori root, parameter ini adalah 0. |
| type | String | Tipe. - FILE: file. - FOLDER: folder. |
| name | String | Nama file atau folder. |
| size | Long | Ukuran file, dalam byte. |
| path | String | Path file atau folder. |
| version | Long | Versi. |
| status | String | Status. - NORMAL: normal. - DELETED: dihapus. - EXPIRED: kedaluwarsa. |
| extension | String | Ekstensi file. |
| creatorId | String | unionId pembuat. |
| modifierId | String | unionId 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 | Informasi properti. |
| readOnly | Boolean | Apakah file atau folder bersifat hanya baca. - true: ya. - false: tidak. |
| appProperties | Map<String, Array> | Properti untuk aplikasi tertentu. |
| Array | Daftar properti ruang. | |
| name | String | Nama properti. |
| value | String | Nilai properti. |
| visibility | String | Visibilitas. - PUBLIC: publik. - PRIVATE: hanya terlihat oleh ruang saat ini. |
| uuid | String | Bidang pengenal. |
| partitionType | String | Partisi penyimpanan. - PUBLIC_OSS_PARTITION: partisi penyimpanan OSS cloud publik. - MINI_OSS_PARTITION: partisi penyimpanan MiniOSS khusus. |
| storageDriver | String | Tipe driver. - DINGTALK: driver penyimpanan terpadu DingTalk. - ALIDOC: driver penyimpanan DingTalk Docs. - UNKNOWN: driver tidak diketahui. |
| thumbnail | Object | Informasi thumbnail. |
| width | Integer | Lebar thumbnail, dalam piksel. |
| height | Integer | Tinggi thumbnail, dalam piksel. |
| url | String | URL thumbnail. |
| nextToken | String | Cursor paginasi. Nilai yang tidak kosong menunjukkan bahwa masih ada data tambahan yang tersedia. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"dentries" : [ {
"id" : "657xxxxx",
"spaceId" : "854xxxxx",
"parentId" : "0",
"type" : "FILE",
"name" : "Folder pengujian",
"size" : 512,
"path" : "./test.txt",
"version" : 1,
"status" : "NORMAL",
"extension" : "txt",
"creatorId" : "cHtUxxxxx",
"modifierId" : "cHtUxxxxx",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z",
"properties" : {
"readOnly" : true
},
"appProperties" : [ {
"name" : "Properti 1",
"value" : "Nilai properti 1",
"visibility" : "PRIVATE"
} ],
"uuid" : "123xxxxx",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK",
"thumbnail" : {
"width" : 64,
"height" : 64,
"url" : "url"
}
} ],
"nextToken" : "next_token"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter. |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk mendapatkan 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 diketahui. |
| 503 | operationTimeout | %s | Permintaan melebihi batas waktu. |