You need to enable JavaScript to run this app.
导航
日志服务
  • 文档首页
    • /
  • 日志服务

CreateHostGroup

最近更新时间：2024.04.19 13:54:13

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

我的收藏

调用 CreateHostGroup 接口创建机器组。

使用说明

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

请求说明

  • 请求方式：POST
  • 请求地址：https://tls-{Region}.ivolces.com/CreateHostGroup

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数类型是否必选示例值描述
HostGroupNameString是mgn1机器组的名称。命名规则请参考资源命名规则。

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

Boolean

否

true

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

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

说明

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

UpdateStartTime

String

否

"00:00"

LogCollector 自动升级的开始时间。

说明

  • 仅在 AutoUpdate 为 true 时需要设置。
  • 自动升级时间建议设置为业务低峰期，自动升级过程中可能会重启 LogCollector，但不会丢失日志。
UpdateEndTimeString否"02:00"LogCollector 自动升级的结束时间。

ServiceLogging

Boolean

否

true

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

  • true：开启
  • false：（默认）关闭。
IamProjectNameString否default机器组所属的 IAM 项目名称。未指定此参数时，日志服务会将机器组添加到名为 default 的 IAM 项目中。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
HostGroupIdStringbcb**********机器组的 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***********"
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
400HostGroupQuotaExceedHostGroup Quota Exceeded超过机器组限额。
400HostIpQuotaExceedHost Ip Quota Exceeded超过机器 IP 限额。
409HostGroupAlreadyExistHostGroup %s already exist机器组已存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。