You need to enable JavaScript to run this app.
导航

CreateHostGroup

最近更新时间2023.11.13 16:31:28

首次发布时间2022.05.11 11:26:48

调用 CreateHostGroup 接口创建机器组。

使用说明

此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
创建 IP 类型的机器组之前,请参考获取服务器的 IP 地址获取机器 IP;创建机器标识类型的机器组时,请参考配置机器标识为机器设置自定义标识。详细说明请参考机器组概述

URI

请求方法
POST

URI

https://tls-{Region}.ivolces.com/CreateHostGroup

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

HostGroupName

String

必选

mgn1

机器组的名称。需要满足以下要求。

  • 只支持小写英文字母、中文、数字和连字符(-)。
  • 必须以小写英文字母、中文、数字开头或结尾。
  • 长度为 3~63 个字符。

HostGroupType

String

必选

IP

机器组的类型。包括:

  • IP:机器 IP。此时需通过 HostIpList 参数设置机器 IP 列表。
  • Label:机器标识。此时需通过 HostIdentifier 参数设置机器标识。

HostIpList

Array of String

可选

["192.168.0.1", "127.0.0.1"]

机器 IP 列表。
HostGroupType 为 IP 时必选。

HostIdentifier

String

可选

hostlable

机器标识。
HostGroupType 为 Label 时必选。

AutoUpdate

Bool

可选

true

机器组服务器中安装的 LogCollector 是否开启自动升级功能。

  • true:日志服务将会在每天的指定时间段进行升级前检查,若满足升级条件,则自动升级 LogCollector,无需手动操作。
  • false:(默认)LogCollector 不自动升级,如需使用更高版本的 LogCollector,请参考升级 LogCollector操作。

说明

仅 LogCollector V1.0.8 及后续版本支持自动升级。

UpdateStartTime

String

可选

"00:00"

LogCollector 自动升级的开始时间。

说明

  • 仅在 AutoUpdate 为 true 时需要设置。
  • 自动升级时间建议设置为业务低峰期,自动升级过程中可能会重启 LogCollector,但不会丢失日志。

UpdateEndTime

String

可选

"02:00"

LogCollector 自动升级的结束时间。

ServiceLogging

Boolean

可选

true

是否开启 Logcollector 服务日志功能。

  • true:开启
  • false:(默认)关闭。

IamProjectName

String

可选

default

机器组所属的 IAM 项目名称。未指定此参数时,日志服务会将机器组添加到名为 default 的 IAM 项目中。

响应参数

参数
参数类型
示例值
说明

HostGroupId

String

bcb**********

机器组的 ID。

示例

请求示例

POST https://tls-{Region}.ivolces.com/CreateHostGroup HTTP/1.1
Content-Type: application/json
...
{
    "HostGroupName": "mgn1",
    "HostGroupType": "IP",
    "HostIpList": ["192.168.0.1", "127.0.0.1"],
    "AutoUpdate": true,
    "UpdateStartTime": "00:00",
    "UpdateEndTime": "02:00",
    "ServiceLogging":true,
    "IamProjectName": "default"
}

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
...
{
    "HostGroupId":"bcb***********"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

HostGroupQuotaExceed

400

HostGroup Quota Exceeded

超过机器组限额。

HostIpQuotaExceed

400

Host Ip Quota Exceeded

超过机器 IP 限额。

HostGroupAlreadyExist

409

HostGroup %s already exist

机器组已存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码