ListFile - 查询文件列表

查询文件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mpserverless:ListFileget
*全部资源
*

请求参数

名称类型必填描述示例值
SpaceIdstring

服务空间 ID。

0e16bb12-14af-4635-xxxx-5ac1a9a7bb9f
PageSizeinteger

每页行数,默认值为 10。

10
Keywordstring

关键字。

关键字1
FileIdstring

要查询的文件的 ID/URL。 支持同时查询多个文件,多个文件 ID 使用半角逗号(,)分隔。最多可以设置 50 个文件 ID/文件 URL。

id1
NextTokenstring

用来标记当前开始读取的位置。置空表示从头开始。

说明 仅商业版支持该功能
CAESBgoEIgIIABgAIrQBCrEBA6wAAAAxTDdmZmZmZmZmZjg5OWJlMzguUzZkNzAyZDY2Mz***
Modestring

文件列表模式,可选值为:

  • DEFAULT(默认) :默认模式,所有文件按照上传时间倒序展示。
  • DIRECTORY:文件夹模式。
DIRECTORY
Prefixstring

路径前缀。默认查询根目录。

/images
AuthDeltainteger

鉴权有效时间,单位秒。只有在您开启了 CDN 配置中的鉴权功能时有效。

1800

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

FE88BEC8-8F83-408A-9ED3-771C510C705F
Paginatorobject

分页信息。

PageSizeinteger

页大小。

10
NextTokenstring

用来标记当前开始读取的位置。置空表示从头开始。

说明 仅商业版支持该功能
eyJhY2NvdW50IjoiMTE2MTQwNTMxMDE0OTY2OCIsImV2ZW50SWQiOiIzMkI3QTE1Mi05NUJFLTUyNkMtQjEyNC00RUYxRDk2RDM4QkEiLCJsb2dJZCI6IjE0LTExNjE0MDUzMTAxNDk2NjgiLCJ0aW1lIjoxNjM1MjEzMzk0MDAwfQ
DataListarray<object>

数据列表。

DataListobject
Typestring

文件类型。包含两个保留类型:

  • directory: 文件夹,此时只有 Name 字段值有效,为文件夹名称。
  • only_in_oss: 数据不一致的文件,出现的原因是用户上传该文件之后没有完成注册导致的数据不一致现象,一般处理方式是删除重新上传。
JPG
Sizeinteger

文件大小。

1000
GmtCreatestring

创建时间。

2020-01-16T05:45:33.000Z
Urlstring

文件下载链接。

https://fbpxxx.cdn.bspapp.com/FBPSBVMO-myspace/68dbd670-3823-11ea-bfb9-xxxx.JPG
GmtModifiedstring

修改时间。

2020-01-16T05:45:33.000Z
Namestring

文件名称。

1579153532001.JPG
Idstring

唯一标识。

c568f23d-a46f-4866-xxxx-142e5eb3e174
AuthDeltainteger

鉴权有效时间,单位秒。只有在您开启了 CDN 配置中的鉴权功能时有效。

1800

示例

正常返回示例

JSON格式

{
  "RequestId": "FE88BEC8-8F83-408A-9ED3-771C510C705F",
  "Paginator": {
    "PageSize": 10,
    "NextToken": "eyJhY2NvdW50IjoiMTE2MTQwNTMxMDE0OTY2OCIsImV2ZW50SWQiOiIzMkI3QTE1Mi05NUJFLTUyNkMtQjEyNC00RUYxRDk2RDM4QkEiLCJsb2dJZCI6IjE0LTExNjE0MDUzMTAxNDk2NjgiLCJ0aW1lIjoxNjM1MjEzMzk0MDAwfQ"
  },
  "DataList": [
    {
      "Type": "JPG",
      "Size": 1000,
      "GmtCreate": "2020-01-16T05:45:33.000Z",
      "Url": "https://fbpxxx.cdn.bspapp.com/FBPSBVMO-myspace/68dbd670-3823-11ea-bfb9-xxxx.JPG",
      "GmtModified": "2020-01-16T05:45:33.000Z",
      "Name": "1579153532001.JPG",
      "Id": "c568f23d-a46f-4866-xxxx-142e5eb3e174",
      "AuthDelta": 1800
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-13OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-04-20OpenAPI 入参发生变更查看变更详情