本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 查询任务的高级配置

查询任务的高级配置

更新时间：2025-04-27 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询任务的高级配置

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/tasks/{task_id}/settings

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID
task_id	是	String	任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID

表2 Query参数
参数	是否必选	参数类型	描述
config_list	否	String	配置项名称列表，当前可选：customImage,includePaths,authId,reviewData,taskName，不建议同时查询多个配置项
offset	否	Integer	分页索引，偏移量，非必填
limit	否	Integer	每页显示的数量，非必填

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	否	String	设置媒体类型和编码格式
X-Auth-Token	是	String	用户Token通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
info	Array of TaskAdvancedSettings objects	高级配置的相关信息
total	Integer	总数

表5 TaskAdvancedSettings
参数	参数类型	描述
key	String	高级配置对应的名称
value	String	高级配置对应的取值
option_value	String	高级配置对应的可选项
description	String	高级配置对应的中文描述

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/settings

响应示例

状态码：200

Request succeeded!

{
  "info" : [ {
    "key" : "customImage",
    "value" : "xxxxx",
    "description" : "自定义镜像",
    "option_value" : ""
  } ],
  "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

错误码

请参见错误码。

父主题：任务管理

下一篇：任务配置高级配置

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询任务的高级配置

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈