文档首页> 部署 CloudDeploy> API参考> API> 主机组管理> 查询主机组
更新时间：2021-09-29 GMT+08:00
查看PDF
分享

查询主机组

功能介绍

根据主机组id查询主机组详情。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/host-groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

String

主机组id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：20000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

group_id

String

主机组id

最小长度：32

最大长度：32

created_time

String

创建时间

updated_time

String

修改时间

host_count

Integer

组内主机数量，一个主机组内最多可添加200台主机

最小值：0

最大值：200

project_name

String

devcloud项目名称

最小长度：3

最大长度：128

name

String

主机组名

region_name

String

局点信息

project_id

String

devcloud项目id

os

String

操作系统：windows|linux

auto_connection_test_switch

Integer

自动连通性验证 0不执行 1每日 2每周

slave_cluster_id

String

slave集群id，默认为null时使用devcloud八爪鱼slave集群，用户自定义slave时为slave集群id

nick_name

String

用户昵称

created_by

UserInfo object

用户信息

update_by

UserInfo object

用户信息

description

String

描述

最小长度：0

最大长度：500

permission

PermissionGroupDetail object

主机组相关权限详情类
表4 UserInfo

参数

参数类型

描述

user_id

String

用户id

user_name

String

用户名
表5 PermissionGroupDetail

参数

参数类型

描述

can_view

Boolean

是否有查看权限

can_edit

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除权限

can_add_host

Boolean

是否有添加主机权限

can_manage

Boolean

是否有管理权限

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

https://{endpoint}/v2/host-groups/ab7647b0863c4e969c8949d38d591339

响应示例

状态码： 200

OK

{
  "name" : "test",
  "description" : "11122211",
  "os" : "linux",
  "region_name" : "cn-north-7",
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "created_by" : {
    "user_id" : "6baa7454109d47c192f22078fe6cda20",
    "user_name" : "devcloud_devcloud_l00490255_01"
  },
  "updated_by" : {
    "user_id" : "6baa7454109d47c192f22078fe6cda20",
    "user_name" : "devcloud_devcloud_l00490255_01"
  },
  "permission" : {
    "can_view" : true,
    "can_edit" : true,
    "can_delete" : true,
    "can_add_host" : true,
    "can_manage" : true
  },
  "auto_connection_test_switch" : 0,
  "slave_cluster_id" : "",
  "nick_name" : "AB边账号",
  "group_id" : "ab7647b0863c4e969c8949d38d591339",
  "created_time" : "2021-04-01 17:05:53",
  "updated_time" : "2021-04-21 14:29:14",
  "host_count" : 1
}

状态码： 400

Bad Request

{
  "error_code" : "Deploy.00021104",
  "error_msg" : "The host group does not exist."
}

状态码： 401

Unauthorized

{
  "error_code" : "Deploy.00021203",
  "error_msg" : "Insufficient permissions."
}

状态码： 403

Forbidden

{
  "error_code" : "Deploy.00021204",
  "error_msg" : "This user is pending real-name authentication."
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码。

父主题： 主机组管理
分享：

    相关文档

    相关产品

close