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

新建主机集群 (推荐)

功能介绍

在项目下新建主机集群。

调用方法

请参见如何调用API

URI

POST /v1/resources/host-groups

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

消息体的类型(格式)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

主机集群名称。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

project_id

String

参数解释

项目id,获取方式请参见获取项目id

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

os

String

参数解释

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

约束限制

不涉及。

取值范围

  • windows:windows操作系统类型。

  • linux:linux操作系统类型。

默认取值

不涉及。

slave_cluster_id

String

参数解释

slave集群id,默认为空,为空时使用默认资源池。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

description

String

参数解释

主机集群描述信息。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

is_proxy_mode

Integer

参数解释

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

约束限制

不涉及。

取值范围

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

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

默认取值

1

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

主机集群id。

取值范围

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

status

String

参数解释

请求成功、失败状态。

取值范围

  • success:请求成功。

  • failed:请求失败。

请求示例

新建主机集群时需填写基本信息,信息包含主机集群名称、描述、操作系统、是否为代理机接入模式等。

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

{
  "name" : "test123",
  "description" : "",
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "os" : "linux",
  "slave_cluster_id" : "",
  "is_proxy_mode" : 1
}

响应示例

状态码:200

OK 请求响应成功

{
  "status" : "success",
  "id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95"
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码