Files:list

功能介绍

列举文件列表。

场景描述

您的应用可以通过Files.list接口列举文件列表。

使用约束

• fields填*时，drive#file 结构中sharer、sharedWithMeTime、hasShared、capabilities、permissions、permissionIds不返回。
• Scope至少包含下面其中一个：
  • https://www.huawei.com/auth/drive.appdata
  • https://www.huawei.com/auth/drive.file
  • https://www.huawei.com/auth/drive
  • https://www.huawei.com/auth/drive.readonly
  • https://www.huawei.com/auth/drive.metadata
  • https://www.huawei.com/auth/drive.metadata.readonly

接口原型

路径参数

无

查询参数

请求参数

Request Header

Request Body

无

请求示例

GET https://driveapis.cloud.huawei.com.cn/drive/v1/files?fields=* HTTP/1.1 
Accept: application/json 
Cache-Control: no-cache 
Authorization: Bearer CF3NTYZSs7MRmxWyj8ssonQQxDgSPAjnDvrf+91NrpN22LdUrMA30A5Kzz0mf55sWao7e7VeLrmjQ0z2OmwPWlt3S00/L1BJppbTFhIgWb74ZBK8CFImUA==

响应参数

状态码为200时:

响应示例

HTTP/1.1 200 OK
{
    "files":[
        {
            "fileName":"V7",
            "editedByMe":true,
            "description":"folder",
            "owners":[
                {
                    "permissionId":"239046878371512704",
                    "displayName":"*******3121@**3.com",
                    "me":true,
                    "category":"drive#user"
                }
            ],
            "hasShared":false,
            "mimeType":"application/vnd.huawei-apps.folder",
            "permissionIds":[
                "233228122990838144"
            ],
            "parentFolder":[
                "Cp35dPknW1dpp1Ru3DdA19KRCyoO3VtRa"
            ],
            "directlyRecycled":false,
            "recycled":false,
            "permissions":[
                {
                    "role":"owner",
                    "deleted":false,
                    "id":"233228122990838144",
                    "category":"drive#permission",
                    "type":"user"
                }
            ],
            "editedByMeTime":"2020-06-04T06:10:47Z",
            "createdTime":"2020-06-04T06:10:47Z",
            "id":"BrVTO-YvKoTkeAFgwfYBJiq5oWUR1SqC5",
            "capabilities":{
                "downloadPermission":true,
                "renameFilePermission":true,
                "commentPermission":true,
                "deletePermission":true,
                "readHistoryVersionPermission":true,
                "recyclePermission":true,
                "addChildNodePermission":true,
                "unrecyclePermission":true,
                "writerHasChangeCopyPermission":false,
                "copyPermission":false,
                "editContentPermission":true,
                "removeChildNodePermission":true,
                "editPermission":true,
                "listChildNodePermission":true,
                "shareFilePermission":true
            },
            "ownedByMe":true,
            "version":1,
            "viewedByMe":false,
            "writersHasSharePermission":false,
            "iconDownloadLink":"https://event-dre.dbankcdn.com/filemanagerpic/20191114091142H5kH.png",
            "editedTime":"2020-06-04T06:10:47Z",
            "writerHasCopyPermission":false,
            "lastEditor":{
                "permissionId":"239046878371512704",
                "displayName":"*******3121@**3.com",
                "me":true,
                "category":"drive#user"
            },
            "existThumbnail":false,
            "containers":[
                "drive"
            ],
            "category":"drive#file",
            "favorite":false
        },
        {
            "fileName":"W23",
            "editedByMe":true,
            "description":"folder",
            "owners":[
                {
                    "permissionId":"239046878371512704",
		    "displayName":"*******3121@**3.com",
                    "me":true,
                    "category":"drive#user"
                }
            ],
            "hasShared":false,
            "mimeType":"application/vnd.huawei-apps.folder",
            "permissionIds":[
                "233228122990838144"
            ],
            "parentFolder":[
                "Cp35dPknW1dpp1Ru3DdA19KRCyoO3VtRa"
            ],
            "directlyRecycled":false,
            "recycled":false,
            "permissions":[
                {
                    "role":"owner",
                    "deleted":false,
                    "id":"233228122990838144",
                    "category":"drive#permission",
                    "type":"user"
                }
            ],
            "editedByMeTime":"2020-06-12T03:05:13Z",
            "createdTime":"2020-06-12T03:05:13Z",
            "id":"BrEiNSYdd6sEe4bx0501O8K90GvR53etB",
            "capabilities":{
                "downloadPermission":true,
                "renameFilePermission":true,
                "commentPermission":true,
                "deletePermission":true,
                "readHistoryVersionPermission":true,
                "recyclePermission":true,
                "addChildNodePermission":true,
                "unrecyclePermission":true,
                "writerHasChangeCopyPermission":false,
                "copyPermission":false,
                "editContentPermission":true,
                "removeChildNodePermission":true,
                "editPermission":true,
                "listChildNodePermission":true,
                "shareFilePermission":true
            },
            "ownedByMe":true,
            "version":1,
            "viewedByMe":false,
            "writersHasSharePermission":false,
            "iconDownloadLink":"https://event-dre.dbankcdn.com/filemanagerpic/20191114091142H5kH.png",
            "editedTime":"2020-06-12T03:05:13Z",
            "writerHasCopyPermission":false,
            "lastEditor":{
                "permissionId":"239046878371512704",
                "displayName":"*******3121@**3.com",
                "me":true,
                "category":"drive#user"
            },
            "existThumbnail":false,
            "containers":[
                "drive"
            ],
            "category":"drive#file",
            "favorite":false
        }
    ],
    "category":"drive#fileList"
}

常见错误码

错误码后4位为业务错误码，用于区分错误场景，其他业务错误码见状态码章节。

调用示例

    public static void main(String[] args) throws IOException {
        // 设置请求地址和用户认证令牌
        String url = "https://driveapis.cloud.huawei.com.cn/drive/v1/files";
        String access_token = "CF3qCeRPLh5GzjpB3ta5UscyjQa2rZhjgFzULNJqVDmCGCJi7IjrQwG7MKmpWIHTq6PRVeYSDsTZtjMbeCoP9ReANeBzHPYRHAppt8HZAaw/3H+IiLbWzQ==";
        // 获取文件列表信息
        JSONObject fileInfo = filesList(url, access_token);
        System.out.println(fileInfo.toJSONString());
    }

    private static JSONObject filesList(String url, String access_token) throws IOException {
        StringBuilder stringBuilder = new StringBuilder("");
        stringBuilder.append("?").append("fields=*");
        stringBuilder.append("&").append("prettyPrint=true");
        HttpGet httpGet = new HttpGet(url + stringBuilder);
        httpGet.setHeader("Authorization","Bearer " + access_token);
        RequestConfig requestConfig = RequestConfig.custom()
            .setConnectTimeout(50000).setConnectionRequestTimeout(10000)
            .setSocketTimeout(50000).build();
        httpGet.setConfig(requestConfig);

        CloseableHttpResponse response = HttpClientUtil.getClient().execute(httpGet);

        try {
            HttpEntity responseEntity = response.getEntity();
            String ret = responseEntity != null ? EntityUtils.toString(responseEntity) : null;
            JSONObject jsonObject = (JSONObject) JSON.parse(ret);
            EntityUtils.consume(responseEntity);
            return jsonObject;
        }finally {
            response.close();
        }
    }