Mendapatkan informasi file atau folder

Panggil API ini untuk mendapatkan informasi tentang file atau folder saat menambahkannya ke ruang penyimpanan.

Deskripsi panggilan API

Saat mendapatkan informasi file atau folder, ukuran file dan ekstensi file tidak dikembalikan untuk entri bertipe folder.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/query`
Metode HTTP	POST
Tipe aplikasi yang didukung	appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga
Izin yang diperlukan	permission-Storage.File.Read-Izin baca pada file penyimpanan organisasi

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses 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 perusahaan yang diberi otorisasi ke aplikasi pihak ketiga.

Parameter path

Nama	Tipe	Wajib	Deskripsi
spaceId	String	Ya	ID ruang. Panggil API Menambahkan ruang untuk mendapatkan nilai parameter `id`.
dentryId	String	Ya	ID file atau folder. Panggil API Mendapatkan daftar file atau folder atau API Mendapatkan spaceId dan dentryId dari dentryUuid untuk mendapatkan nilai parameter `id`.

Parameter query

Nama	Tipe	Wajib	Deskripsi
unionId	String	Ya	unionId operator. Panggil API Mengkueri detail pengguna untuk mendapatkan nilai parameter `unionid`.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
option	Object	Tidak	Parameter opsional.
appIdsForAppProperties	Array of String	Tidak	Mengembalikan properti terlihat yang sesuai dengan menentukan daftar `ownerId` ruang. Maksimum: 20. - Ketika `ownerType` adalah `APP`, `ownerId` adalah identifier aplikasi. - Ketika `ownerType` adalah `USER`, `ownerId` adalah unionId pembuat.
withThumbnail	Boolean	Tidak	Apakah akan mendapatkan tautan sementara ke thumbnail file. Dapatkan sesuai kebutuhan karena memengaruhi latensi API. - true: Dapatkan. - false (default): Jangan dapatkan.

Contoh permintaan

HTTP

POST /v1.0/storage/spaces/854xxxxx/dentries/653xxxxx/query?unionId=cHtUYxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "option" : {
    "appIdsForAppProperties" : [ "123" ],
    "withThumbnail" : false
  }
}

Java

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.GetDentryHeaders getDentryHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetDentryHeaders();
        getDentryHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest.GetDentryRequestOption()
                .setAppIdsForAppProperties(java.util.Arrays.asList(
                    "123"
                ))
                .setWithThumbnail(false);
        com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest getDentryRequest = new com.aliyun.dingtalkstorage_1_0.models.GetDentryRequest()
                .setUnionId("cHtUYxxxxx")
                .setOption(option);
        try {
            client.getDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, 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 properti code dan message untuk membantu Anda menemukan 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 berisi properti code dan message untuk membantu Anda menemukan issue
            }

        }        
    }
}

Python

# -*- 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 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_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            client.get_dentry_with_options('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message untuk membantu Anda menemukan issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_dentry_headers = dingtalkstorage__1__0_models.GetDentryHeaders()
        get_dentry_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.GetDentryRequestOption(
            app_ids_for_app_properties=[
                '123'
            ],
            with_thumbnail=False
        )
        get_dentry_request = dingtalkstorage__1__0_models.GetDentryRequest(
            union_id='cHtUYxxxxx',
            option=option
        )
        try:
            await client.get_dentry_with_options_async('854xxxxx', '653xxxxx', get_dentry_request, get_dentry_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message untuk membantu Anda menemukan issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?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\GetDentryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetDentryRequest;
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();
        $getDentryHeaders = new GetDentryHeaders([]);
        $getDentryHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "appIdsForAppProperties" => [
                "123"
            ],
            "withThumbnail" => false
        ]);
        $getDentryRequest = new GetDentryRequest([
            "unionId" => "cHtUYxxxxx",
            "option" => $option
        ]);
        try {
            $client->getDentryWithOptions("854xxxxx", "653xxxxx", $getDentryRequest, $getDentryHeaders, 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 properti code dan message untuk membantu Anda menemukan 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 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
  }

  getDentryHeaders := &dingtalkstorage_1_0.GetDentryHeaders{}
  getDentryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.GetDentryRequestOption{
    AppIdsForAppProperties: []*string{tea.String("123")},
    WithThumbnail: tea.Bool(false),
  }
  getDentryRequest := &dingtalkstorage_1_0.GetDentryRequest{
    UnionId: tea.String("cHtUYxxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetDentryWithOptions(tea.String("854xxxxx"), tea.String("653xxxxx"), getDentryRequest, getDentryHeaders, &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 properti code dan message untuk membantu Anda menemukan issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'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 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 getDentryHeaders = new dingtalkstorage_1_0.GetDentryHeaders({ });
    getDentryHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_1_0.GetDentryRequestOption({
      appIdsForAppProperties: [
        '123'
      ],
      withThumbnail: false,
    });
    let getDentryRequest = new dingtalkstorage_1_0.GetDentryRequest({
      unionId: 'cHtUYxxxxx',
      option: option,
    });
    try {
      await client.getDentryWithOptions('854xxxxx', '653xxxxx', getDentryRequest, getDentryHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err berisi properti code dan message untuk membantu Anda menemukan 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 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.GetDentryHeaders getDentryHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryHeaders();
            getDentryHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest.GetDentryRequestOption
            {
                AppIdsForAppProperties = new List<string>
                {
                    "123"
                },
                WithThumbnail = false,
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest getDentryRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetDentryRequest
            {
                UnionId = "cHtUYxxxxx",
                Option = option,
            };
            try
            {
                client.GetDentryWithOptions("854xxxxx", "653xxxxx", getDentryRequest, getDentryHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err berisi properti code dan message untuk membantu Anda menemukan 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 berisi properti code dan message untuk membantu Anda menemukan issue
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
dentry	Object	Informasi file atau folder.
id	String	ID file atau folder.
spaceId	String	ID ruang tempat file atau folder berada.
parentId	String	ID folder induk. Untuk folder root, parameter ini adalah `0`.
type	String	Tipe: - FILE: File. - FOLDER: Folder.
name	String	Nama file atau folder. Jika berupa file, nilai bidang ini menyertakan ekstensi file.
size	Long	Ukuran file, dalam byte. Bidang ini tidak dikembalikan untuk folder.
path	String	Path file atau folder di dalam ruang.
version	Long	Versi.
status	String	Status: - NORMAL: Normal. - DELETED: Sampah. - EXPIRED: Kedaluwarsa.
extension	String	Ekstensi file. Bidang ini tidak dikembalikan untuk folder.
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	Atribut file atau folder.
readOnly	Boolean	Apakah file atau folder bersifat hanya baca: - true: Ya. - false: Tidak.
appProperties	`Map<String, Array>`	Atribut pada aplikasi tertentu. Key adalah identifier ruang, dan value adalah daftar atribut.
	Array	Daftar atribut.
name	String	Nama atribut.
value	String	Nilai atribut.
visibility	String	Visibilitas atribut: - PUBLIC: Terlihat oleh semua aplikasi. - PRIVATE: Terlihat hanya oleh aplikasi saat ini.
uuid	String	Identifier bisnis.
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.

Contoh isi respons

HTTP/1.1 200 OK
Content-Type:application/json

{
  "dentry" : {
    "id" : "653xxxxx",
    "spaceId" : "854xxxxx",
    "parentId" : "parent_id",
    "type" : "FILE",
    "name" : "TestFile.xsl",
    "size" : 512,
    "path" : "/TestFile.xsl",
    "version" : 1,
    "status" : "NORMAL",
    "extension" : "xsl",
    "creatorId" : "cHtUYxxxxx",
    "modifierId" : "cHtUYxxxxx",
    "createTime" : "2022-01-01T10:00:00Z",
    "modifiedTime" : "2022-01-01T10:00:00Z",
    "properties" : {
      "readOnly" : true
    },
    "appProperties" : [ {
      "name" : "property_name",
      "value" : "property_value",
      "visibility" : "PRIVATE"
    } ],
    "uuid" : "uuid",
    "partitionType" : "PUBLIC_OSS_PARTITION",
    "storageDriver" : "DINGTALK",
    "thumbnail" : {
      "width" : 64,
      "height" : 64,
      "url" : "url"
    }
  }
}

Kode error

Jika error dikembalikan 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 informasi file atau folder.
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 melampaui batas waktu.

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Mendapatkan informasi file atau folder

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Deskripsi panggilan API

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter path

​Parameter query

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error