更新时间:2021-09-29 GMT+08:00
分享

新建主机组

功能介绍

在项目下新建主机组。

调试

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

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

局点信息

最小长度:0

最大长度:256

project_id

String

devcloud项目id

os

String

操作信息:windows|linux

枚举值:

  • windows

  • linux

slave_cluster_id

String

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

description

String

描述

最小长度:0

最大长度:500

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

group_id

String

主机组ID

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

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

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

响应示例

状态码: 200

OK

{
  "group_id" : "f3938bd63e354d2bb9d9cf7b5dc3bf95"
}

状态码: 400

Bad Request

{
  "error_code" : "Deploy.00021001",
  "error_msg" : "Invalid parameter."
}

状态码: 401

Unauthorized

{
  "error_code" : "Deploy.00021200",
  "error_msg" : "You do not have permissions to create host groups."
}

状态码: 403

Forbidden

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读