调用CLI命令创建机器组。

请求语法

aliyunlog log create_machine_group --project_name=<value> --group_detail=<value> [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>]

请求参数

该命令的必选和特有参数描述如下。
参数名称 数值类型 是否必选 示例值 描述
--project_name String aliyun-test-project Project名称。
--group_detail JSON Object file://./machinegroup.json 机器组配置文件路径。
关于该命令的全局参数,请参见全局参数

示例

  1. 创建machinegroup.json文件,其中机器组名称为group_name2。其内容示例如下:
    {
      "machine_list": [
        "machine1",
        "machine2"
      ],
      "machine_type": "userdefined",
      "group_name": "group_name2",
      "group_type": "",
      "group_attribute": {
        "externalName": "ex name",
        "groupTopic": "topic x"
      }
    }
    各参数说明如下:
    参数名称 说明
    machine_list 机器组的标识信息。
    • 如果machine_type配置为ip,则此处填写服务器的IP地址。
    • 如果machine_type配置为userdefined,则此处填写自定义的标识。如何配置用户自定义标识,请参见配置用户自定义标识
    machine_type 机器标识类型。
    • ip:IP地址机器组。
    • userdefined:用户自定义标识机器组。
    group_name 机器组名称。其命名规则如下:
    • 同一个Project下,不可重复。
    • 只能包含小写字母、数字、短划线(-)和下划线(_)。
    • 必须以小写字母或者数字开头和结尾。
    • 长度为3~128字符。
    group_type 机器组类型,取值为空字符串。
    group_attribute 机器组的属性。详细请参考下表group_attribute参数说明。
    其中group_attribute参数说明如下表所示:
    参数名称 说明
    externalName 机器组所依赖的外部管理系统(Armory)标识。
    groupTopic 机器组的日志主题。
  2. 使用默认账号创建名称为group_name2的机器组。
    aliyunlog log create_machine_group --project_name="aliyun-test-project" --group_detail="file://./machinegroup.json"
    命令执行成功后,无响应消息。
  3. 查询已创建的机器组。命令示例如下:
    aliyunlog log get_machine_group --project_name="aliyun-test-project" --group_name="group_name2"
    返回结果如下:
    {
      "createTime": 1622104319,
      "groupAttribute": {
        "externalName": "ex name",
        "groupTopic": "topic x"
      },
      "groupName": "group_name2",
      "groupType": "",
      "lastModifyTime": 1622104319,
      "machineIdentifyType": "userdefined",
      "machineList": [
        "machine1",
        "machine2"
      ]
    }

错误码

如果返回报错信息,请参见具体接口的错误码处理。更多信息,请参见CreateMachineGroup错误码处理

API参考

CreateMachineGroup