文档首页/ 部署 CodeArts Deploy/ API参考/ 应用示例/ 示例1:查询主机集群列表
更新时间:2023-07-06 GMT+08:00

示例1:查询主机集群列表

场景描述

本章以软件开发生产线用户为例,指导您通过API查询主机集群列表。

API的调用方法请参见如何调用API

前提条件

用户已经创建软件开发生产线项目。

总体思路

通过用户token查询当前用户所有的主机集群列表。

查询主机集群列表

  • 接口信息:
URI:GET /v2/host-groups
  • 请求示例:
GET  https://{endpoint}/v2/host-groups?region_name=ap-southeast-3&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=create_time&sort_dir=DESC
  • 响应示例:
    { 
      "total" : 1, 
      "host_groups" : [ { 
        "name" : "testwyk", 
        "description" : "11122211", 
        "os" : "linux", 
        "nick_name" : "AB边账号", 
        "id" : 200001291, 
        "group_id" : "ab7647b0863c4e969c8949d38d591339", 
        "region_name" : "ap-southeast-3",
        "project_id" : "6039d4480efc4dddb178abff98719913", 
        "permission" : { 
          "can_view" : true, 
          "can_edit" : true, 
          "can_delete" : true, 
          "can_add_host" : true, 
          "can_manage" : true 
        }, 
        "created_by" : { 
          "user_id" : "6baa7454109d47c192f22078fe6cda20", 
          "user_name" : "devcloud_devcloud_l00490255_01" 
        }, 
        "updated_by" : { 
          "user_id" : "6baa7454109d47c192f22078fe6cda20", 
          "user_name" : "devcloud_devcloud_l00490255_01" 
        }, 
        "auto_connection_test_switch" : 0, 
        "slave_cluster_id" : "", 
        "created_time" : "2021-04-01 17:05:53", 
        "updated_time" : "2021-04-21 14:29:14", 
        "host_count" : 1, 
        "project_name" : null 
      } ] 
    }