查询文件列表

接口描述（Description）

查询文件列表

请求地址（Request URL）

[GET] https://file.sensenova.cn/v1/files

请求头（Request Header）

无特殊Header，请参考接口鉴权

请求参数（Query Parameters）

名称	类型	必须	默认值	可选值	描述
paging.offset	int	否	0	-	分页参数，从列表的第几条开始获取
paging.limit	int	否	50	-	分页参数，每页返回结果的数量限制

请求示例（Request Example）

curl --request GET "https://file.sensenova.cn/v1/files" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_TOKEN" 

响应（Response）

名称	类型	描述
files	object[]	文件列表
paging	object	分页信息

• 其中，files 部分参数如下：

名称	类型	描述
id	string	文件ID
description	string	文件描述
scheme	string	文件格式
created_at	string	文件创建时间，ISO 8601标准时间格式，精确到纳秒
updated_at	string	文件更新时间，ISO 8601标准时间格式，精确到纳秒
status	string	文件状态，枚举值 未上传/上传中：NOTUPLOADED 已上传（等待格式校验）：UPLOADED 文件无效（格式校验不通过）：INVALID 文件有效（格式校验通过）：VALID
file_name	string	文件名称
validate_result	string	文件校验结果

• 其中，paging 部分参数如下：

名称	类型	描述
offset	int	分页参数，从列表的第几条开始获取
limit	int	分页参数，每页返回结果的数量限制
total	int	分页参数，列表总条数

响应示例（Response Example）

{
  "files":[
    {
      "id": "string", 
      "description": "string",
      "scheme": "string",
      "created_at": "2023-06-28T17:23:01.243566533Z", 
      "updated_at": "2023-06-28T17:23:01.243566533Z",
      "status": "string", 
      "file_name": "string",
      "validate_result": "string"
    }
  ],
  "paging": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

错误信息

参考错误码