文档首页> 部署 CodeArts Deploy> API参考> API> 主机集群管理> 查询主机集群关联环境信息
更新时间：2024-06-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询主机集群关联环境信息

功能介绍

查询主机集群关联环境信息。

调用方法

请参见如何调用API。

URI

GET /v1/resources/host-groups/{group_id}/environments/infos

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

String

主机集群id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

page_index

否

Integer

页码

最小值：1

最大值：2147483647

page_size

否

Integer

每页查询条数

最小值：1

最大值：1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：20000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

请求成功失败状态

total

Integer

关联环境总数量

result

Array of EnvironmentInfo objects

环境信息列表
表5 EnvironmentInfo

参数

参数类型

描述

id

String

环境id

name

String

环境名称

app_id

String

应用id

app_name

String

应用名称

project_id

String

项目id

请求示例

https://{endpoint}/v1/resources/host-groups/849f425a74034fd2a4e60c367414efba/environments/infos?page_index=1&page_size=10

响应示例

状态码： 200

OK 请求响应成功

{
  "status" : "success",
  "result" : [ {
    "id" : "54e5b8b0d10148cc96142ac9d6c1c1f6",
    "name" : "更新测试环境",
    "project_id" : "7e6caf3cd9a64d5b8ea451e38221892e",
    "app_name" : "虚机部署更新",
    "app_id" : "8ddf0566c1784da29faac80516fa8425"
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码。

父主题： 主机集群管理
分享：

    相关文档

    相关产品