更新时间:2025-12-25 GMT+08:00

查询主机集群 (推荐)

功能介绍

根据主机集群id查询主机集群详情。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

group_id

String

参数解释

主机集群id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

result

HostClusterInfoDetailDetail object

参数解释

主机集群信息。

表4 HostClusterInfoDetailDetail

参数

参数类型

描述

id

String

参数解释

主机集群id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

主机集群名称。

取值范围

只能由中文字符、英文字母、数字及"-"、"_"、"."组成,且长度为[3-128]个字符。

os

String

参数解释

主机集群的操作系统类型。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

slave_cluster_id

String

参数解释

自定义资源池id。

取值范围

只能由英文字母、数字组成,且长度为32个字符,或为空。

created_by

UserInfo object

参数解释

创建者用户信息,包含用户id,用户名等。

description

String

参数解释

主机集群描述信息。

取值范围

字符串,长度为[0-500]个字符。

permission

PermissionClusterDetail object

参数解释

当前用户对主机集群的操作权限矩阵。

nick_name

String

参数解释

创建者用户昵称。

取值范围

字符串,长度为[1-30]个字符。

is_proxy_mode

Integer

参数解释

是否为代理模式主机集群。

取值范围

  • 0:非代理模式主机集群。

  • 1:代理模式主机集群。

created_time

String

参数解释

主机集群创建时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2021-04-01 17:05:53'。

取值范围

不涉及。

updated_time

String

参数解释

主机集群更新时间,格式为yyyy-MM-dd HH:mm:ss。例如:'2021-04-01 17:05:53'。

取值范围

不涉及。

表5 UserInfo

参数

参数类型

描述

user_id

String

参数解释

用户id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

user_name

String

参数解释

用户名。

取值范围

只能由英文字母、数字组成,且长度为[1-255]个字符。

表6 PermissionClusterDetail

参数

参数类型

描述

can_view

Boolean

参数解释

是否有查看权限。

取值范围

  • true:有查看权限。

  • false:无查看权限。

can_edit

Boolean

参数解释

是否有编辑权限。

取值范围

  • true:有编辑权限。

  • false:无编辑权限。

can_delete

Boolean

参数解释

是否有删除权限。

取值范围

  • true:有删除权限。

  • false:无删除权限。

can_add_host

Boolean

参数解释

是否有添加主机权限。

取值范围

  • true:有添加主机权限。

  • false:无添加主机权限。

can_manage

Boolean

参数解释

是否有管理主机集群权限矩阵的权限。

取值范围

  • true:有管理主机集群权限矩阵的权限。

  • false:无管理主机集群权限矩阵的权限。

can_copy

Boolean

参数解释

是否有复制主机的权限。

取值范围

  • true:有复制主机的权限。

  • false:无复制主机的权限。

请求示例

https://{endpoint}/v1/resources/host-groups/ab7647b0863c4e969c8949d38d591339

响应示例

状态码:200

OK 请求响应成功

{
  "status" : "success",
  "result" : {
    "id" : "ab7647b0863c4e969c8949d38d591339",
    "name" : "test",
    "description" : "11122211",
    "os" : "linux",
    "created_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,
      "can_copy" : true
    },
    "is_proxy_mode" : 0,
    "slave_cluster_id" : "",
    "nick_name" : "AB边账号",
    "created_time" : "2021-04-01 17:05:53",
    "updated_time" : "2021-04-21 14:29:14"
  }
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码