获取自定义执行机列表 - QueryOctopusResourcePools

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过32。

默认取值：

不涉及。

page

否

Integer

参数解释：

分页编号，从1开始。

约束限制：

不涉及。

取值范围：

≥1

默认取值：

1

page_size

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

1-50

默认取值：

50

search

否

String

参数解释：

需要查找的自定义执行机资源池的名称。

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过50。

默认取值：

不涉及。

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1~100000]个字符。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

• zh-cn：中文。

• en-us：英文。

默认取值：

zh-cn。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

• OK：请求已成功处理，服务器返回了请求的资源或操作结果。

• ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。

• INTERNAL_SERVER_ERROR：接口内部异常。

• BAD_REQUEST：参数校验异常。

result

ResourcePoolsResult object

参数解释：

资源池详情。

status

String

参数解释：

接口响应状态。

取值范围：

• success：接口响应成功。

• error：接口响应失败。

resourcePoolId

String

参数解释：

启用的资源池ID，使用内置执行机的情况下该字段为空。

取值范围：

字符串长度不少于1，不超过32。

resourcePoolName

String

参数解释：

启用的资源池名称，使用内置执行机的情况下该字段为空。

取值范围：

字符串长度不少于1，不超过50。

resourcePools

Array of ResourcePoolsItemResponse objects

参数解释：

可选的资源池列表。

取值范围：

不涉及。

resourceType

String

参数解释：

资源池名类型。

取值范围：

• custom：自定义资源池。

• default：内置资源池。

resource_pool_type

String

参数解释：

启用的资源池类型。

取值范围：

• default：内置资源池。

• exclusive：专属资源池。

• self-hosted：自定义资源池。

total

Integer

参数解释：

总数。

取值范围：

≥0

id

String

参数解释：

资源池ID。

取值范围：

字符串长度不少于1，不超过32。

isSelected

Boolean

参数解释：

资源池是否被启用。

取值范围：

• true：启用该资源池。

• false：未启用该资源池。

name

String

参数解释：

资源池名称。

取值范围：

字符串长度不少于1，不超过50。

resource_type

String

参数解释：

资源池种类。

取值范围：

• default：内置资源池。

• exclusive：专属资源池。

• self-hosted：自定义资源池。

type

String

参数解释：

资源池类型。

取值范围：

• MAC。

• WINDOWS_VM。

• VM。

• DOCKER。

• default。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

Request succeeded!

400

Bad Request

401

Unauthorized