文档首页/ 部署 CodeArts Deploy/ API参考/ API/ 主机集群管理/ 查询应用下环境基本信息列表
更新时间:2024-06-28 GMT+08:00

查询应用下环境基本信息列表

功能介绍

查询应用下环境基本信息列表。

调用方法

请参见如何调用API

URI

GET /v1/applications/{application_id}/host-groups/base/infos

表1 路径参数

参数

是否必选

参数类型

描述

application_id

String

应用id

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

project_uuid

String

项目id

最小长度:32

最大长度:32

os

String

操作系统:windows|linux

最小长度:0

最大长度:128

枚举值:

  • linux

  • windows

page_index

Integer

分页页码

最小值:1

最大值:2147483647

page_size

Integer

分页查询每页条数

最小值:1

最大值:1000

name

String

按主机集群名称搜索关键字

最小长度:0

最大长度:128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:20000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

total

Integer

总数量

result

Array of EnvironmentBaseInfo objects

环境基本信息列表

表5 EnvironmentBaseInfo

参数

参数类型

描述

name

String

环境名称

os

String

操作系统:windows|linux

uuid

String

环境id

group_id

String

主机集群id

host_count

Integer

环境下主机数量

请求示例

https://{endpoint}/v1/applications/fe50d93c5a7f4335bb44a68419606ced/host-groups/base/infos?project_uuid=7e6caf3cd9a64d5b8ea451e38221892e&page_index=1&page_size=1000

响应示例

状态码: 200

OK 请求响应成功

{
  "status" : "success",
  "result" : [ {
    "name" : "新建环境测试权限",
    "os" : "linux",
    "uuid" : "c51d2173c541496c9561f77ccdacf13e",
    "group_id" : "c51d2173c541496c9561f77ccdacf13e",
    "host_count" : 0
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码