文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 探测任务对应的代码仓语言,只支持探测CodeArtsRepo仓库的任务
更新时间:2025-09-04 GMT+08:00
分享

探测任务对应的代码仓语言,只支持探测CodeArtsRepo仓库的任务

功能介绍

探测任务对应的代码仓语言,只支持探测CodeArtsRepo仓库的任务。

调用方法

请参见如何调用API

URI

GET /v1/tasks/{task_id}/detect-language

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

scan_file

String

参数解释:

识别仓库语言时是否扫描代码仓文件列表。scan_file为true时会通过扫描文件列表识别仓库语言,scan_file为false时会使用CodeArtsRepo服务的语言统计接口识别代码仓语言。

约束限制:

不涉及。

取值范围:

true、false。

默认取值:

true。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释:

HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。

取值范围:

  • OK,接口响应成功。

  • ACCEPTED,接口响应成功。

  • INTERNAL_SERVER_ERROR,接口内部异常。

  • BAD_REQUEST,参数校验异常。

result

String

参数解释:

探测语言结果,如果探测出多个语言则以英文逗号","分隔,例如:"JAVA,XML"。

取值范围:

不涉及。

status

String

参数解释:

接口响应状态。

取值范围:

  • success,接口响应成功。

  • error,接口响应失败。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

用扫描文件的方式探测任务ID为897acf5exxx48a5013cd的代码检查任务对应的仓库的语言。

GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/detect-language?scan_file=true

响应示例

状态码:400

Bad Request

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

状态码:401

Unauthorized

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

状态码

状态码

描述

200

CodeArtsRepo仓代码检查任务的语言探测结果

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档