更新时间:2022-03-31 GMT+08:00
分享

查询共享存储文件

功能介绍

  • 接口名称

    ListShareFiles

  • 功能描述

    查询共享存储指定路径下的文件列表,该功能仅在支持共享存储的云手机规格上可实现。您可通过查询云手机规格列表的“extend_spec”参数,查询云手机规格是否支持共享存储(“extend_spec”参数中包含“max_share_disk_size_g”字段,表示支持)。

URI

GET /v1/{project_id}/cloud-phone/servers/share-files?path=/data/data&server_ids=xxxxxxx,xxxxxxx&limit=100&offset=0

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

path

String

待查询的目录名称

可以包含大小写字母、数字、“.”、“+”、“-”、“_”、“/”、"=";必须以“/”开头,并且不能只包含“/”;不能包含“../”、“//”等。

示例:/data/data

server_ids

String

云手机服务器ID列表

可通过查询云手机服务器列表获取,多个服务器ID用逗号(,)分隔。

offset

Integer

偏移量

偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源数,默认值为0。

limit

Integer

每页返回的资源个数

取值范围:1~50(默认值为50)

一般设置为10、20、50

请求消息

  • 请求参数

  • 请求样例
    GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/share-files?path=/data/data&server_ids=203a7243181646b190047ade6bfd882d

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    jobs

    Array of objects

    任务信息,详情请参见表2

    表2 job数据结构说明

    参数

    参数类型

    描述

    server_id

    String

    云手机服务器的唯一标识

    job_id

    String

    任务的唯一标识

  • 响应样例
    {
        "request_id": "6837531fd3f54550927b930180a706bf",
        "jobs": [
            {
                "server_id": "203a7243181646b190047ade6bfd882d",
                "job_id": "1564567b8bab40f34711234cb80d0123"
            }
        ]
    }

任务结果说明

查询结果会通过任务的execute_msg字段返回,任务查询结果请参考查询任务执行状态

表3 execute_msg说明

参数

参数类型

描述

files_in_path

files_in_path结构体

指定目录下的文件列表,数据的格式为:

[文件大小 时间 文件名]

share_base_capacity

String

共享存储整体容量信息,四个字段分别为:

Size Used Avail Use%

share_base_max_size

String

共享存储总大小

表4 files_in_path说明

参数

参数类型

描述

total

Integer

指定目录下的文件总个数

count

Integer

本次查询返回的指定目录下的文件数目

files

Array of strings

指定目录下的文件列表,数据的格式为:

[文件大小 时间 文件名]

任务结果示例:

{
    "error_msg": null,
    "execute_msg": "{\"files_in_path\":{\"total\":1,\"count\":1,\"files\":[\"4096 Apr 15 09:49 com.tencent.mm\"]},\"share_base_max_size\":\"50G\",\"share_base_capacity\":\"8.9G 323M 8.2G 4%\"}",
    "job_id": "1564567b8bab40f34711234cb80d0123",
    "end_time": "2020-07-28T07:32:14Z",
    "begin_time": "2020-07-28T07:31:50Z",
    "error_code": null,
    "request_id": "af28fb2c79f84b74821e99a4b3aace53",
    "status": 2
}

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

close