更新任务使用的执行机 - UpdateOctopusResourcePools
功能介绍
更新任务使用的执行机资源池,支持设置当前任务执行时使用的资源池为默认资源池、专属资源池或自定义资源池。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartscheck:task:update |
Write |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
PUT /v1/tasks/{task_id}/resource-pool
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过32。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]个字符。 默认取值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 语言,决定响应以哪种语言返回。 约束限制: 不涉及。 取值范围:
默认取值: zh-cn。 |
|
Content-Type |
否 |
String |
参数解释: 设置媒体类型和编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json;charset=UTF-8 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resourceType |
是 |
String |
参数解释: 资源池类型。 约束限制: 字符串长度不少于1,不超过32。 取值范围:
默认取值: 不涉及。 |
|
resourcePools |
否 |
Array of ResourcePool objects |
参数解释: 资源池信息。 约束限制: 使用自定义资源池或者专属资源池时参数必填;使用内置资源池时参数可不传。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
参数解释: 资源池ID。可通过获取自定义执行机列表接口的返回值可获取资源池ID。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过32。 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: 资源池名称。可通过获取自定义执行机列表接口的返回值可获取资源池名称。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过50。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
httpStatus |
String |
参数解释: HTTP响应状态。 取值范围:
|
|
result |
String |
参数解释: 响应信息。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 接口响应状态。 取值范围:
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
更新任务使用的执行机。
PUT https://{endpoint}/v1/tasks/{task_id}/resource-pool
{
"resourceType" : "custom",
"resourcePools" : [ {
"id" : "e8fc38d6exxxxfd39f39xxxx0c5f4a45",
"name" : "new_engine_4u8g"
} ]
}
响应示例
状态码:200
Request succeeded!
{
"httpStatus" : "OK",
"result" : "update resource pool success",
"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 |
错误码
请参见错误码。