探测任务对应的代码仓语言 - RecognizePortalServiceCodeLanguage
功能介绍
根据任务ID、扫描代码仓文件对任务所在的代码仓进行语言探测，探测到多个语言时将以英文逗号分隔并同时返回，方便用户根据探测结果启用语言对应规则集。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartscheck:task:get |
Read |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
GET /v1/tasks/{task_id}/detect-language
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~128]个字符。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
scan_file |
是 |
String |
参数解释： 识别仓库语言时是否扫描代码仓文件列表。 约束限制： 不涉及。 取值范围：
默认取值： true。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 长度为[1~100000]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
httpStatus |
String |
参数解释： HTTP响应状态。 取值范围：
|
|
result |
String |
参数解释： 探测语言结果，如果探测出多个语言则以英文逗号","分隔，例如："JAVA,XML"。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 接口响应状态。 取值范围：
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释： 错误码。 取值范围： 不涉及。 |
|
error_msg |
String |
参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
用扫描文件的方式探测任务ID为897acf5exxx48a5013cd的代码检查任务对应的仓库的语言。
GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/detect-language?scan_file=true
响应示例
状态码：200
Request succeeded!
{
"httpStatus" : "OK",
"result" : "JAVASCRIPT,CSS,SQL",
"status" : "success"
}
状态码：400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
