Deskripsi panggilan API
Saat mengambil informasi tentang file dan folder, bidang ukuran file dan ekstensi file tidak tersedia untuk folder.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/query |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin | 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 yang digunakan untuk memanggil API ini. Dapatkan sebagai berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token organisasi yang diberi otorisasi ke aplikasi pihak ketiga. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang. Panggil API Menambahkan ruang untuk mendapatkan nilai parameter id. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Panggil API Kueri detail pengguna untuk mendapatkan nilai parameter unionid. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| dentryIds | Array of String | Ya | Daftar ID file atau folder. Maksimal 30 ID didukung. Panggil API Mendapatkan daftar file atau folder atau Mendapatkan spaceId dan dentryId berdasarkan dentryUuid untuk mendapatkan nilai parameter id. |
| option | Object | Tidak | Parameter opsional. |
| appIdsForAppProperties | Array of String | Tidak | Daftar ID aplikasi yang ditentukan. Maksimal 20 ID didukung. Panggil API Mendapatkan informasi ruang untuk mendapatkan nilai parameter ownerId. - Jika parameter ini ditentukan, properti file atau folder untuk aplikasi yang ditentukan akan dikembalikan. - Jika parameter ini tidak ditentukan, properti file atau folder untuk semua aplikasi akan dikembalikan. |
| withThumbnail | Boolean | Tidak | Apakah akan mengambil informasi thumbnail file. - true: Ya - false: Tidak Ambil sesuai kebutuhan. Mengambil thumbnail akan meningkatkan waktu respons API. |
Contoh permintaan
HTTPPOST /v1.0/storage/spaces/798xxxxx/dentries/query?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"dentryIds" : [ "478xxxxx" ],
"option" : {
"appIdsForAppProperties" : [ "chyxxxxx" ],
"withThumbnail" : true
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using 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.GetDentriesHeaders getDentriesHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesHeaders();
getDentriesHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest.GetDentriesRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest.GetDentriesRequestOption()
.setAppIdsForAppProperties(java.util.Arrays.asList(
"chyxxxxx"
))
.setWithThumbnail(true);
com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest getDentriesRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentriesRequest()
.setUnionId("chyxxxxx")
.setDentryIds(java.util.Arrays.asList(
"478xxxxx"
))
.setOption(option);
try {
client.getDentriesWithOptions("798xxxxx", getDentriesRequest, getDentriesHeaders, 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 berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
} 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 berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
}
}
# -*- coding: utf-8 -*-
# File ini dibuat otomatis, jangan diedit. Terima kasih.
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 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()
get_dentries_headers = dingtalkstorage__1__0_models.GetDentriesHeaders()
get_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.GetDentriesRequestOption(
app_ids_for_app_properties=[
'chyxxxxx'
],
with_thumbnail=True
)
get_dentries_request = dingtalkstorage__1__0_models.GetDentriesRequest(
union_id='chyxxxxx',
dentry_ids=[
'478xxxxx'
],
option=option
)
try:
client.get_dentries_with_options('798xxxxx', get_dentries_request, get_dentries_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message, yang membantu Anda memecahkan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_dentries_headers = dingtalkstorage__1__0_models.GetDentriesHeaders()
get_dentries_headers.x_acs_dingtalk_access_token = '<your access token>'
option = dingtalkstorage__1__0_models.GetDentriesRequestOption(
app_ids_for_app_properties=[
'chyxxxxx'
],
with_thumbnail=True
)
get_dentries_request = dingtalkstorage__1__0_models.GetDentriesRequest(
union_id='chyxxxxx',
dentry_ids=[
'478xxxxx'
],
option=option
)
try:
await client.get_dentries_with_options_async('798xxxxx', get_dentries_request, get_dentries_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message, yang membantu Anda memecahkan masalah
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// File ini dibuat otomatis, jangan diedit. Terima kasih.
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\GetDentriesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentriesRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentriesRequest;
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();
$getDentriesHeaders = new GetDentriesHeaders([]);
$getDentriesHeaders->xAcsDingtalkAccessToken = "<your access token>";
$option = new option([
"appIdsForAppProperties" => [
"chyxxxxx"
],
"withThumbnail" => true
]);
$getDentriesRequest = new GetDentriesRequest([
"unionId" => "chyxxxxx",
"dentryIds" => [
"478xxxxx"
],
"option" => $option
]);
try {
$client->getDentriesWithOptions("798xxxxx", $getDentriesRequest, $getDentriesHeaders, 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 berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
}
}
$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 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
}
getDentriesHeaders := &dingtalkstorage_1_0.GetDentriesHeaders{}
getDentriesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
option := &dingtalkstorage_1_0.GetDentriesRequestOption{
AppIdsForAppProperties: []*string{tea.String("chyxxxxx")},
WithThumbnail: tea.Bool(true),
}
getDentriesRequest := &dingtalkstorage_1_0.GetDentriesRequest{
UnionId: tea.String("chyxxxxx"),
DentryIds: []*string{tea.String("478xxxxx")},
Option: option,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetDentriesWithOptions(tea.String("798xxxxx"), getDentriesRequest, getDentriesHeaders, &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 berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'use strict';
// File ini dibuat otomatis, jangan diedit
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 using 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 getDentriesHeaders = new dingtalkstorage_1_0.GetDentriesHeaders({ });
getDentriesHeaders.xAcsDingtalkAccessToken = '<your access token>';
let option = new dingtalkstorage_1_0.GetDentriesRequestOption({
appIdsForAppProperties: [
'chyxxxxx'
],
withThumbnail: true,
});
let getDentriesRequest = new dingtalkstorage_1_0.GetDentriesRequest({
unionId: 'chyxxxxx',
dentryIds: [
'478xxxxx'
],
option: option,
});
try {
await client.getDentriesWithOptions('798xxxxx', getDentriesRequest, getDentriesHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
}
}
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 using 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.GetDentriesHeaders getDentriesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesHeaders();
getDentriesHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest.GetDentriesRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest.GetDentriesRequestOption
{
AppIdsForAppProperties = new List<string>
{
"chyxxxxx"
},
WithThumbnail = true,
};
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest getDentriesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentriesRequest
{
UnionId = "chyxxxxx",
DentryIds = new List<string>
{
"478xxxxx"
},
Option = option,
};
try
{
client.GetDentriesWithOptions("798xxxxx", getDentriesRequest, getDentriesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
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 berisi atribut code dan message, yang membantu Anda memecahkan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| resultItems | Array | Daftar informasi file atau folder yang diambil secara massal. |
| spaceId | String | ID ruang tempat file atau folder berada. |
| dentryId | String | ID file atau folder. |
| success | Boolean | Apakah file atau folder berhasil diambil. true menunjukkan berhasil. |
| errorCode | String | Alasan error. |
| dentry | Object | Informasi file atau folder. |
| id | String | ID file atau folder. |
| spaceId | String | ID ruang tempat file atau folder berada. |
| parentId | String | ID direktori induk file atau folder. ID direktori 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 | Nomor versi file atau folder. |
| status | String | Status. - NORMAL: Normal - DELETED: Sampah - 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 file atau folder. |
| readOnly | Boolean | Apakah file atau folder hanya baca. - true: Ya - false: Tidak |
| appProperties | Map<String, Array> | Properti untuk aplikasi tertentu. |
| Array | Daftar properti. | |
| name | String | Nama properti. |
| value | String | Nilai properti. |
| visibility | String | Visibilitas properti. - PUBLIC: Terlihat oleh semua aplikasi - PRIVATE: Terlihat hanya 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 Shanji - UNKNOWN: Driver tidak diketahui |
| thumbnail | Object | Informasi thumbnail. |
| width | Integer | Lebar thumbnail, dalam piksel. |
| height | Integer | Tinggi thumbnail, dalam piksel. |
| url | String | URL thumbnail. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"resultItems" : [ {
"spaceId" : "798xxxxx",
"dentryId" : "478xxxxx",
"success" : true,
"errorCode" : "permissionDenied",
"dentry" : {
"id" : "478xxxxx",
"spaceId" : "798xxxxx",
"parentId" : "367xxxxx",
"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" : "Atribut1",
"value" : "NilaiAtribut1",
"visibility" : "PRIVATE"
} ],
"uuid" : "uuid",
"partitionType" : "PUBLIC_OSS_PARTITION",
"storageDriver" : "DINGTALK",
"thumbnail" : {
"width" : 64,
"height" : 64,
"url" : "url"
}
}
} ]
}
Kode error
Jika panggilan API gagal, temukan 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 mengambil informasi tentang file atau folder. |
| 404 | spaceNotExist | %s | Ruang tidak ada. |
| 500 | systemError | %s | Error sistem |
| 500 | unknownError | Unknown Error | Error tidak diketahui |
| 503 | operationTimeout | %s | permintaan habis waktu |