文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 获取代码仓所有文件列表
更新时间:2025-08-19 GMT+08:00

获取代码仓所有文件列表

功能介绍

获取代码仓所有文件的列表

调用方法

请参见如何调用API

URI

GET /v4/tasks/{task_id}/file-list

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

Array of strings

参数解释:

代码仓文件列表

取值范围:

不涉及

total

Integer

参数解释:

总数

取值范围:

0-2147483647

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v4/tasks/897acf5exxx48a5013cd/file-list

响应示例

状态码:200

Request succeeded!

{
  "data" : [ "README.md" ],
  "total" : 1
}

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码