获取资源池列表
功能介绍
获取资源池列表
调用方法
请参见如何调用API。
URI
GET /v4/{project_id}/resource-pools
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
success|error |
result |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
request_id |
String |
参数解释 由接口调用方传入,建议使用UUID保证请求的唯一性。 取值范围 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
参数解释 符合条件的所有记录数 取值范围 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
Array of ResourcePoolVo objects |
参数解释 本次查询的记录结果 取值范围 实际的数据类型:单个对象,集合 或 NULL |
reason |
String |
参数解释 业务失败的提示内容 取值范围 不涉及 |
page_size |
Integer |
参数解释 每页展示条数 取值范围 不涉及 |
page_no |
Integer |
参数解释 页码 取值范围 不涉及 |
has_more |
Boolean |
参数解释 是否有更多 取值范围 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释 资源池ID 取值范围 不涉及 |
name |
String |
参数解释 资源池名称 取值范围 不涉及 |
type |
String |
参数解释 资源池类型 取值范围 (VM/DOCKER) |
selected |
String |
参数解释 是否选中 取值范围 不涉及 |
active_state |
String |
参数解释 资源池状态 取值范围 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
请求示例
GET https://{endpoint}/testexecutor/v4/90f8dc52eb7b4c47b853c661152ca62d/resource-pools
响应示例
状态码:200
OK
{ "result" : { "value" : [ { "id" : "DEFAULT", "name" : "DEFAULT", "type" : "DEFAULT", "selected" : "true", "active_state" : "DEFAULT" } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。