查询任务的高级配置 - ShowTaskSettings
功能介绍
根据项目ID、任务ID和配置项列表分页查询任务的高级配置,返回高级配置的名称、取值、可选项。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartscheck:task:get |
Read |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
GET /v2/{project_id}/tasks/{task_id}/settings
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位UUID,项目唯一标识,通过查询项目列表接口获取。 约束限制: 不涉及。 取值范围: 32位项目ID。 默认取值: 不涉及。 |
|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过32。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
config_list |
否 |
String |
参数解释: 配置项名称列表,当前可选:customImage,includePaths,authId,reviewData,taskName,不建议同时查询多个配置项。 约束限制: 不涉及。 取值范围:
默认取值: customImage,authId |
|
offset |
否 |
Integer |
参数解释: 偏移量。 约束限制: 不涉及。 取值范围: ≥0 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 每页显示的数量。 约束限制: 不涉及。 取值范围: 1-1000 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
info |
Array of TaskAdvancedSettings objects |
高级配置的相关信息 |
|
total |
Integer |
总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释: 高级配置对应的名称。 取值范围: 不涉及。 |
|
value |
String |
参数解释: 高级配置对应的取值。 取值范围: 不涉及。 |
|
option_value |
String |
参数解释: 高级配置对应的可选项。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 高级配置对应的中文描述。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。