公共说明

站点信息

Drive服务端采用全球域名https://driveapis.cloud.huawei.com.cn,任何支持Drive服务的国家和地区都可以直接使用全球域名。但我们强烈建议您,先通过调用About:get接口获取用户信息后,使用domain字段对应的分站点域名来访问我们的服务,以便于为您提供更高效的服务体验。

服务

站点信息(rootUrl)

Drive

中国站点:https://drive-drcn.cloud.dbankcloud.cn

欧洲站点:https://drive-dre.cloud.dbankcloud.cn

亚非拉站点:https://drive-dra.cloud.dbankcloud.cn

俄罗斯站点:https://drive-drru.cloud.dbankcloud.cn

fields参数使用说明

参数

描述

fileds

采用[Partial-response格式]

[Partial-response格式]查询参数使用方式如下:

以About:get接口为例:

当不传fields时,响应有默认值。

如果只需要获取其中的部分响应信息,则可以修改fileds参数,例如你需要获取响应中的domain和user中的me,则可以设置fields =domain,user(me)或者fields =domain,user/me,响应如下所示:

{
    "domain":"driveapis.cloud.huawei.com.cn",
    "user":{
        "me":true,
     }
}

queryParam参数使用说明

参数

描述

queryParam

查询语句,应用可根据该查询语句设置过滤条件,查询指定文件或文件夹。过滤条件格式为:"属性名 操作符 属性值"。多个过滤条件采用“and”连接。若不设置查询语句,则默认返回云盘下所有文件及文件夹。查询语句当前支持的属性请参见下表。

过滤条件为指定查询某父目录下文件或文件夹时,过滤条件格式固定为:fileId in parents。fileId为指定的父目录文件id。

queryParam查询语句,支持的属性如下:

参数

类型

操作

参数值

描述

mimeType

String

=,!=,contains

application/vnd.huawei-apps.folder

指定查询类型为文件或者目录(文件夹)。

"mimeType='application/vnd.huawei-apps.folder'"表示查询目录;"mimeType!='application/vnd.huawei-apps.folder'"表示查询文件。

若不设置mimeType,则默认查询文件及目录。

parentFolder

Array

in

fileId(待查询的父目录ID)

用于查询指定父目录下的文件或目录。

固定格式为:fileId + "in parentFolder"。目前只支持一个fileId,如果有多个只取第一个。fileId需要用单引号引起来。

若不指定父目录,则默认查询根目录文件或文件夹。

注意:对于云盘根目录可用'root' in parentFolder,对于应用数据根目录可用'applicationData' in parentFolder。

recycled

Boolean

=

true/false

用于设置只查询回收站中的当前文件夹及其下的文件和子文件夹。

directlyRecycled

Boolean

=

true/false

用于设置只查询回收站中的当前文件或文件夹。

fileName

String

=,!=,contains

fileName(文件名称)

用于查询指定文件(夹)名的文件或者目录。其中包含是指匹配以name开头的文件名或者目录名。文件名用单引号引起来。

editedTime

DateTime

<=,<,=,!=,>,>=

editedTime(文件(夹)最后修改时间)

用于查询指定修改时间范围内的文件或目录。RFC 3339格式,默认时区为UTC,例如2020-10-16T07:16:47.000Z。时间需要以单引号引起来。

favorite

Boolean

=,!=

true/false

文件是否被收藏。

Tip:

queryParam查询语句示例(假定某文件夹A的fileId为:f192358798744098816):

  1. 查询A文件夹下所有文件:“'f192358798744098816' in parentFolder and mimeType != 'application/vnd.huawei-apps.folder'”。
  2. 查询回收站下所有目录:“mimeType = 'application/vnd.huawei-apps.folder' and recycled = true”。

查询条件“'fileId' in parentFolder”和“recycled = true”不可共同设置,即不能指定查询回收站某个父目录下文件或文件夹。

mimeType参数使用说明

参数

描述

mimeType

文件类型,具体的取值范围参照下表,

如果文件类型为目录,则mimeType取值为"application/vnd.huawei-apps.folder"。

mimeType取值范围如下表所示 :

文件名称后缀

mimeType取值

.3gp

video/3gpp

.apk

application/vnd.android.package-archive

.asf

video/x-ms-asf

.avi

video/x-msvideo

.bin

application/octet-stream

.bmp

image/bmp

.c

text/plain

.class

application/octet-stream

.conf

text/plain

.cpp

text/plain

.doc

application/msword

.docx

application/vnd.openxmlformats-officedocument.wordprocessingml.document

.xls

application/vnd.ms-excel

.xlsx

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

.exe

application/octet-stream

.gif

image/gif

.gtar

application/x-gtar

.gz

application/x-gzip

.h

text/plain

.htm

text/html

.html

text/html

.jar

application/java-archive

.java

text/plain

.jpeg

image/jpeg

.jpg

image/jpeg

.jpe

image/jpeg

.js

application/x-javascript

.log

text/plain

.m3u

audio/x-mpegurl

.m4a

audio/mp4a-latm

.m4b

audio/mp4a-latm

.m4p

audio/mp4a-latm

.m4u

video/vnd.mpegurl

.m4v

video/x-m4v

.mov

video/quicktime

.mp2

audio/x-mpeg

.mp3

audio/x-mpeg

.mp4

video/mp4

.mpc

application/vnd.mpohun.certificate

.mpeg

video/mpeg

.mpe

video/mpeg

.mpg

video/mpeg

.mpg4

video/mp4

.mpga

audio/mpeg

.msg

application/vnd.ms-outlook

.ogg

audio/ogg

.pdf

application/pdf

.png

image/png

.pps

application/vnd.ms-powerpoint

.ppt

application/vnd.ms-powerpoint

.pptx

application/vnd.openxmlformats-officedocument.presentationml.presentation

.prop

text/plain

.rc

text/plain

.rmvb

audio/x-pn-realaudio

.rtf

application/rtf

.sh

text/plain

.tar

application/x-tar

.tgz

application/x-compressed

.txt

text/plain

.wav

audio/x-wav

.wma

audio/x-ms-wma

.wmv

video/x-ms-wmv

.wps

application/vnd.ms-works

.xml

text/plain

.z

application/x-compress

.zip

application/x-zip-compressed

.wbmp

image/vnd.wap.wbmp

.webp

image/webp

.raw

image/x-panasonic-raw

.dng

image/x-adobe-dng

.arw

image/x-sony-arw

.tif

image/tiff

.ico

image/x-icon

.mpo

image/mpo

.mkv

video/x-matroska

.webm

video/x-matrosk

.m2ts

video/mpeg

.3g2

video/3gpp2

.rm

video/x-pn-realvideo

.rv

video/x-pn-realvideo

.ts

video/mp2ts

.flv

video/x-flv

.k3g

video/k3g

Region参数定义说明

给文档添加锚定评论

添加评论时,需要指明锚定到文件中的某个区域。position是指文件的评论所在的revision和region,评论资源通过一个JSON字符串来定义一个position。

定义锚定区域

JSON字符串包含revision和region两个属性。region是一个包含区域分类器的JSON数组,这些分类器指定了评论锚定的格式和位置。分类器可以是图像的二维矩形,文档中的一行文本,视频中的持续时间等等。要定义region,需要先选择与待锚定的内容类型匹配的region分类器。

如下示例,该字符串将评论锚定到文档两个单独region中的不同行。

  • 第一个region从第50行('n':50)开始,并覆盖下面10行('l':10)。
  • 第二个region仅覆盖第1行('n':1,'l':1)。
    {
      'revision': revisionId,
      'region': [
      {
        'line':
        {
          'ln': 50,
          'len': 10,
        }
      },
      {
        'line':
        {
          'ln': 1,
          'len': 1,
        }
      }]
    }

region分类器

以下是Drive API附上的所有区域分类器的列表:

  • rect : 二维图像中的矩形。

    属性

    描述

    类型

    x

    在x轴上的位置,默认指图片文件的像素或PDF文件的百分比。

    double

    y

    在y轴上的位置,默认指图片文件的像素或PDF文件的百分比。

    double

    w

    x轴的长度,默认指图片文件的像素或PDF文件的百分比。

    double

    h

    y轴的长度,默认指图片文件的像素或PDF文件的百分比。

    double

    maxw

    评论时文件的宽度。通过此参数、x和w的结合确定评论的x轴位置及长度。

    double

    maxh

    评论时文件的高度。通过此参数、y和h的结合确定评论的y轴位置及长度。

    double

    rotation

    文档的旋转度。必须是0、90、180、270中的一个。

    double

  • page : pdf或其他带页码的文档中的页码。将其用于具有类似页面元素的文档。

    属性

    描述

    类型

    p

    页码(索引下标从0开始)。

    integer

    c

    本文档的总页数。

    integer

  • time :视频或其他文档中具有时间维度的持续时间。

    属性

    描述

    类型

    t

    开始时间。

    string

    d

    范围内的持续时间。

    string

    fd

    文档的完整持续时间。

    string

  • txt : 文字范围。

    属性

    描述

    类型

    off

    起始偏移量(距文件开头的字符偏移量)。

    integer

    len

    文字范围的长度。

    integer

    flen

    此文档的长度(以字符为单位)。

    integer

  • line : 文本文件中的特定行或其中包含行的任何文件。

    属性

    描述

    类型

    ln

    行号。

    integer

    len

    行范围的长度。

    integer

    flen

    文件中的最大行数。

    integer

  • matrix : 矩阵状结构中的位置。用于定义电子表格文档或任何其他具有行或列结构的文档中的行和列。

    属性

    描述

    类型

    col

    列号。

    integer

    row

    行号。

    integer

    w

    列数。

    integer

    h

    行数。

    integer

    maxw

    最大宽度。

    integer

    maxh

    最大高度。

    integer

Search
Enter a keyword.