更新时间:2024-04-10 GMT+08:00
分享

新建主机集群

功能介绍

在项目下新建主机集群。该接口于2024年09月30日后不再维护,推荐使用新版新建主机集群(CreateHostCluster)接口。

调用方法

请参见如何调用API

URI

POST /v2/host-groups

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),下方类型可任选其一使用: application/json;charset=utf-8 application/json

缺省值:application/json;charset=utf-8

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

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

最小长度:0

最大长度:20000

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

主机集群名

最小长度:3

最大长度:128

region_name

String

局点信息

最小长度:1

最大长度:20

project_id

String

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

os

String

操作系统:windows|linux

枚举值:

  • windows

  • linux

slave_cluster_id

String

slave集群id,默认为null时使用默认slave集群,用户自定义slave时为slave集群id

description

String

描述

最小长度:0

最大长度:500

is_proxy_mode

Integer

主机集群是否为代理机接入模式, 1:是 0:否

枚举值:

  • 0

  • 1

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

group_id

String

主机集群ID

请求示例

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

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

{
  "name" : "test123",
  "description" : "",
  "region_name" : "cn-north-7",
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "os" : "linux",
  "slave_cluster_id" : "",
  "is_proxy_mode" : 1
}

响应示例

状态码: 200

OK 请求响应成功

{
  "group_id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95"
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码

分享:

    相关文档

    相关产品