リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems/{recycleItemId} |
| HTTP Method | GET |
| サポートされるアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-Storage.RecycleBin.Read-企業ストレージのゴミ箱読み取り権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリの access_token を取得するインターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業の access_token を取得するインターフェースを呼び出して取得します。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| recycleBinId | String | はい | ゴミ箱 ID。ゴミ箱情報の取得インターフェースを呼び出して取得できます。 |
| recycleItemId | String | はい | ゴミ箱項目 ID。ゴミ箱項目リストの取得インターフェースを呼び出して id パラメータの値を取得できます。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| unionId | String | はい | 操作者の unionId。ユーザー詳細の照会インターフェースを呼び出して取得できます。 |
リクエスト例
HTTPGET /v1.0/storage/recycleBins/pQy3R7xxxxx/recycleItems/2190xxxxx?unionId=chyxxxxx 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.GetRecycleItemHeaders getRecycleItemHeaders = new com.aliyun.dingtalkstorage_1_0.models.GetRecycleItemHeaders();
getRecycleItemHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.GetRecycleItemRequest getRecycleItemRequest = new com.aliyun.dingtalkstorage_1_0.models.GetRecycleItemRequest()
.setUnionId("chyxxxxx");
try {
client.getRecycleItemWithOptions("pQy3R7xxxxx", "2190xxxxx", getRecycleItemRequest, getRecycleItemHeaders, 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 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)) {
// err contains code and message properties to help locate 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()
get_recycle_item_headers = dingtalkstorage__1__0_models.GetRecycleItemHeaders()
get_recycle_item_headers.x_acs_dingtalk_access_token = '<your access token>'
get_recycle_item_request = dingtalkstorage__1__0_models.GetRecycleItemRequest(
union_id='chyxxxxx'
)
try:
client.get_recycle_item_with_options('pQy3R7xxxxx', '2190xxxxx', get_recycle_item_request, get_recycle_item_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 the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_recycle_item_headers = dingtalkstorage__1__0_models.GetRecycleItemHeaders()
get_recycle_item_headers.x_acs_dingtalk_access_token = '<your access token>'
get_recycle_item_request = dingtalkstorage__1__0_models.GetRecycleItemRequest(
union_id='chyxxxxx'
)
try:
await client.get_recycle_item_with_options_async('pQy3R7xxxxx', '2190xxxxx', get_recycle_item_request, get_recycle_item_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 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\GetRecycleItemHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\GetRecycleItemRequest;
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();
$getRecycleItemHeaders = new GetRecycleItemHeaders([]);
$getRecycleItemHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getRecycleItemRequest = new GetRecycleItemRequest([
"unionId" => "chyxxxxx"
]);
try {
$client->getRecycleItemWithOptions("pQy3R7xxxxx", "2190xxxxx", $getRecycleItemRequest, $getRecycleItemHeaders, 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 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/service"
dingtalkstorage_1_0 "github.com/alibabacloud-go/dingtalk/storage_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/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
}
getRecycleItemHeaders := &dingtalkstorage_1_0.GetRecycleItemHeaders{}
getRecycleItemHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getRecycleItemRequest := &dingtalkstorage_1_0.GetRecycleItemRequest{
UnionId: tea.String("chyxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetRecycleItemWithOptions(tea.String("pQy3R7xxxxx"), tea.String("2190xxxxx"), getRecycleItemRequest, getRecycleItemHeaders, &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 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 getRecycleItemHeaders = new $dingtalkstorage_1_0.GetRecycleItemHeaders({ });
getRecycleItemHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getRecycleItemRequest = new $dingtalkstorage_1_0.GetRecycleItemRequest({
unionId: "chyxxxxx",
});
try {
await client.getRecycleItemWithOptions("pQy3R7xxxxx", "2190xxxxx", getRecycleItemRequest, getRecycleItemHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message properties to help locate 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.GetRecycleItemHeaders getRecycleItemHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetRecycleItemHeaders();
getRecycleItemHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetRecycleItemRequest getRecycleItemRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.GetRecycleItemRequest
{
UnionId = "chyxxxxx",
};
try
{
client.GetRecycleItemWithOptions("pQy3R7xxxxx", "2190xxxxx", getRecycleItemRequest, getRecycleItemHeaders, 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 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))
{
// err contains code and message properties to help locate the issue
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| item | Object | ゴミ箱項目情報。 |
| id | String | ゴミ箱項目 ID。 |
| spaceId | String | 元のファイルまたはフォルダーが存在していたスペース ID。 |
| dentryId | String | 元のファイルまたはフォルダーの ID。 |
| size | Long | 元のファイルまたはフォルダーのサイズ。単位は Byte。 |
| type | String | タイプ。 - FILE:ファイル - FOLDER:フォルダー |
| originalName | String | 元のファイルまたはフォルダーの名前。 |
| originalPath | String | 元のファイルまたはフォルダーのパス。 |
| operatorId | String | 削除操作者の unionId。 |
| operatorTime | String | 削除日時。iso8601 形式(例:2022-07-29T14:55Z)。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"item" : {
"id" : "2190xxxxx",
"spaceId" : "4847xxxxx",
"dentryId" : "658xxxxx",
"size" : 512,
"type" : "FILE",
"originalName" : "テストフォルダー",
"originalPath" : "./テストフォルダー",
"operatorId" : "chyxxxxx",
"operatorTime" : "2022-01-01T10:00:00Z"
}
}
エラーコード
本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を確認してください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | paramError | %s | パラメータエラー |
| 400 | paramError.recycleBinId | %s | パラメータエラー-recycleBinId |
| 403 | permissionDenied | %s | ユーザーにゴミ箱項目の元ファイル(フォルダー)に対する閲覧権限がありません |
| 404 | recycleBinNotExist | %s | ゴミ箱が存在しません |
| 404 | recycleItemNotExist | %s | ゴミ箱項目が存在しません |
| 500 | systemError | %s | システムエラー |
| 500 | unknownError | Unknown Error | 不明なエラー |
| 503 | operationTimeout | %s | リクエストがタイムアウトしました |