文档

使用Python SDK管理机器组

更新时间:

机器组是包含多台服务器的虚拟分组,日志服务通过机器组的方式管理所有需要通过Logtail采集日志的服务器。本文通过代码示例介绍如何创建、修改、查询、删除机器组等。

前提条件

  • 已创建RAM用户并完成授权。具体操作,请参见创建RAM用户并完成授权

  • 已配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见在Linux、macOS和Windows系统配置环境变量

    重要
    • 阿里云账号的AccessKey拥有所有API的访问权限,建议您使用RAM用户的AccessKey进行API访问或日常运维。

    • 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。

  • 已安装Python SDK。更多信息,请参见安装Python SDK

  • 已创建Project。具体操作,请参见创建Project示例代码

注意事项

本示例以华东1(杭州)的公网Endpoint为例,其公网Endpoint为https://cn-hangzhou.log.aliyuncs.com。如果您通过与Project同地域的其他阿里云产品访问日志服务,请使用内网Endpointhttps://cn-hangzhou-intranet.log.aliyuncs.com。关于日志服务支持的地域与Endpoint的对应关系,请参见服务入口

创建机器组示例代码

以下代码用于创建名为ali-test-machinegroup的IP地址机器组。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"

if __name__ == '__main__':
    print("ready to create machinegroup")

    # JSON格式的机器组配置信息。在这里定义机器标识、机器标识类型、机器组类型、机器组名称等。
    my_json_str = {
        "machine_list": ["47.100.XX.XX", "47.100.XX.XX"],
        "machine_type": "ip",
        "group_type": "",
        "group_name": "ali-test-machinegroup",
        "group_attribute": {
            "groupTopic": ""
        }
    }
    # 创建机器组配置对象。
    machine_group_detail = MachineGroupDetail()
    # 从JSON格式读取机器组配置。
    machine_group_detail.from_json(my_json_str)
    # 调用接口创建机器组。
    res1 = client.create_machine_group(project_name, machine_group_detail)

    print("create machinegroup success")            

预期结果如下:

ready to create machinegroup
create machinegroup success

修改机器组示例代码

控制台支持界面化操作机器组配置,操作更便捷。具体操作,请参见管理机器组

以下代码用于修改指定机器组的配置。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"
# 机器组名称,请您根据实际情况填写。请从已创建机器组中获取机器组名称。
group_name = "ali-test-machinegroup"


if __name__ == '__main__':
    print("ready to update machinegroup")

    # 调用接口查询待修改的机器组配置信息。
    print("Before update, the machine list is:")
    res = client.get_machine_group(project_name, group_name)
    print(res.get_machine_group().machine_list)

    # Json格式的机器组配置信息。在这里定义修改后的机器标识、机器标识类型、机器组类型、机器组名称等。该代码中,为machine_list增加一个machine。
    my_json_str = {
        "machine_list": ["47.100.XX.XX", "47.100.XX.XX", "47.100.XX.XX"],
        "machine_type": "ip",
        "group_type": "",
        "group_name": "ali-test-machinegroup",
        "group_attribute": {
            "groupTopic": ""
        }
    }
    # 创建机器组配置对象,用于后续修改机器组。
    machine_group_detail = MachineGroupDetail()
    # 从Json格式读取机器组配置。
    machine_group_detail.from_json(my_json_str)
    # 调用接口修改机器组。
    client.update_machine_group(project_name, machine_group_detail)

    print("After update, the machine list is:")
    res2 = client.get_machine_group(project_name, group_name)
    print(res2.get_machine_group().machine_list)

    print("update machinegroup success")

预期结果如下:

ready to update machinegroup
Before update, the machine list is:
['47.100.XX.XX', '47.100.XX.XX']
After update, the machine list is:
['47.100.XX.XX', '47.100.XX.XX', '47.100.XX.XX']
update machinegroup success

查询所有机器组示例代码

以下代码用于查询所有机器组。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"

if __name__ == '__main__':
    print("ready to list machinegroup")

    # 调用接口查询所有机器组。
    res = client.list_machine_group(project_name, 0, 100)
    for machine_group in res.get_machine_group():
        print(machine_group)

    print("list machinegroup success")

预期结果如下:

ready to list machinegroup
ali-test-machinegroup
ali-test-machinegroup2
ali-test-machinegroup3
list machinegroup success

删除指定机器组示例代码

以下代码用于删除指定机器组。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"
# 机器组名称,请您根据实际情况填写。请从已创建机器组中获取机器组名称。
group_name = "ali-test-machinegroup"

if __name__ == '__main__':
    print("ready to delete machinegroup")

    # 调用接口删除指定机器组。
    client.delete_machine_group(project_name, group_name)

    print("delete machinegroup success")

预期结果如下:

ready to delete machinegroup
delete machinegroup success

获取指定机器组示例代码

以下代码用于获取指定机器组的配置信息。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"
# 机器组名称,请您根据实际情况填写。请从已创建机器组中获取机器组名称。
group_name = "ali-test-machinegroup"


if __name__ == '__main__':
    print("ready to get machinegroup")

    # 调用接口查询指定机器组的配置信息。
    res = client.get_machine_group(project_name, group_name)
    print(res.get_machine_group().to_json())

    print("get machinegroup success")

预期结果如下:

ready to get machinegroup
{'groupName': 'ali-test-machinegroup', 'groupType': '', 'groupAttribute': {'externalName': '', 'groupTopic': '', 'osType': '', 'region': '', 'policy': ''}, 'machineIdentifyType': 'ip', 'machineList': ['47.100.XX.XX', '47.100.XX.XX']}
get machinegroup success

将Logtai采集配置应用到机器组示例代码

控制台支持界面化操作Logtail配置,操作更便捷。具体操作,请参见管理Logtail采集配置

以下代码用于将Logtail配置应用到机器组。

from aliyun.log import LogClient, MachineGroupDetail
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# 日志服务Project名称,请您根据实际情况填写。请从已创建项目中获取Project名称。
project_name = "ali-test-project"
# 机器组名称,请您根据实际情况填写。请从已创建机器组中获取机器组名称。
group_name = "ali-test-machinegroup"

# Logtail配置,请您根据实际情况填写。请从已创建Logtail配置中获取配置名称。
config_name = "ali-test-logtailconfig"


if __name__ == '__main__':
    print("ready to apply config to machinegroup")

    # 调用接口将Logtail配置应用到机器组。
    client.apply_config_to_machine_group(project_name, config_name, group_name)

    print("apply config to machinegroup success")

预期结果如下:

ready to apply config to machinegroup
apply config to machinegroup success

相关文档