更新时间:2024-09-12 GMT+08:00
分享

获取资源池列表

功能介绍

获取资源池列表

URI

GET /testexecutor/v4/{project_id}/resource-pools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListResourcePoolVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

表4 ResultValueListResourcePoolVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值

value

Array of ResourcePoolVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表5 ResourcePoolVo

参数

参数类型

描述

id

String

资源池ID

name

String

资源池名称

type

String

资源池类型(VM/DOCKER)

selected

String

是否选中

active_state

String

资源池状态

表6 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 400

表7 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表8 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表9 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表10 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档