使用云助手自动化管理实例

运维 ECS 实例的目的是保持 ECS 实例的最佳状态以及确保排错的效率，但是手动维护会花费您大量的时间和精力，因此阿里云研制了 云助手，用以解决如何自动化、批量处理日常维护任务。本文举例如何使用云助手 API，为 ECS 实例执行相应命令，达到自动化运维 ECS 实例的目的。

命令类型介绍


目前，云助手支持如下三种命令类型。

• 
  您需要确保目标 ECS 实例的网络类型为 专有网络（VPC）。
• 
  目标 ECS 实例的状态必须为 运行中（Running）。
• 
  目标 ECS 实例必须预先安装云助手客户端。您可以参阅 阿里云助手 安装并使用云助手客户端。
• 
  执行类型为 PowerShell 的命令时，您需要确保目标 Windows 实例已经配置了 PowerShell 模块。
• 
  以下示例在命令行工具中完成，您需要确保您已经安装了阿里云命令行工具 CLI（Command-Line Interface）。
  Windows 实例参阅 在线安装命令行工具和 SDK。
• 
  Linux 实例参阅 在线安装命令行工具和 SDK。

1. 下载文件 aliyunOpenApiData.py。
2. 使用下载的文件替换路径中 %python_install_path%\Lib\site-packages\aliyuncli 中的文件 aliyunOpenApiData.py。[/url]
3. 
   运行 aliyuncli ecs InvokeCommand --InstanceIds your-vm-instance-id1 instance-id2 --CommandId your-command-id --Timed false [url=https://help.aliyun.com/document_detail/64841.html]执行命令（InvokeCommand）。

   
   注意：

   • InstanceIds 为您的 ECS 实例 ID，支持多台 ECS 实例，最多 100 台。
   • Timed 表示是否为周期性任务，Timed True 表示是周期性任务，Timed False表示不是周期性任务。
   • 当您的任务为周期性任务时，即参数 Timed 取值为 True 时，您需要通过参数 Frequency 指定周期，例如 0 */20 * * * * 表示周期为每 20 分钟。更多关于 Cron 表达式详情，请参阅 Cron 表达式取值说明。
   • 返回结果为所有的目标 ECS 实例返回一个共同的 InvokeId。您可以使用该 InvokeId 查询命令的执行情况。

1. # coding=utf-8
2. # if the python sdk is not install using 'sudo pip install aliyun-python-sdk-ecs'
3. # if the python sdk is install using 'sudo pip install --upgrade aliyun-python-sdk-ecs'
4. # make sure the sdk version is 2.1.2, you can use command 'pip show aliyun-python-sdk-ecs' to check
5. import json
6. import logging
7. import os
8. import time
9. import datetime
10. import base64
11. from aliyunsdkcore import client
13. from aliyunsdkecs.request.v20140526.CreateCommandRequest import CreateCommandRequest
14. from aliyunsdkecs.request.v20140526.InvokeCommandRequest import InvokeCommandRequest
15. from aliyunsdkecs.request.v20140526.DescribeInvocationResultsRequest import DescribeInvocationResultsRequest
17. # configuration the log output formatter, if you want to save the output to file,
18. # append ",filename='ecs_invoke.log'" after datefmt.
19. logging.basicConfig(level=logging.INFO,
20.                     format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
21.                     datefmt='%a, %d %b %Y %H:%M:%S',filename='aliyun_assist_openapi_test.log', filemode='w')
22. #access_key = 'Your Access Key Id'
23. #acess_key_secrect = 'Your Access Key Secrect'
24. #region_name = 'cn-shanghai'
25. #zone_id = 'cn-shanghai-b'
27. access_key = 'LTAIXXXXXXXXXXXX'
28. acess_key_secrect = '4dZXXXXXXXXXXXXXXXXXXXXXXXX'
29. region_name = 'cn-hangzhou'
30. zone_id = 'cn-hangzhou-f'
32. clt = client.AcsClient(access_key, acess_key_secrect, region_name)
34. def create_command(command_content, type, name, description):
35.     request = CreateCommandRequest()
36.     request.set_CommandContent(command_content)
37.     request.set_Type(type)
38.     request.set_Name(name)
39.     request.set_Description(description)
40.     response = _send_request(request)
41.     if response is None:
42.         return None
43.     command_id = response.get('CommandId')
44.     return command_id;
46. def invoke_command(instance_id, command_id, timed, cronat):
47.     request = InvokeCommandRequest()
48.     request.set_Timed(timed)
49.     InstanceIds = [instance_id]
50.     request.set_InstanceIds(InstanceIds)
51.     request.set_CommandId(command_id)
52.     request.set_Frequency(cronat)
53.     response = _send_request(request)
54.     invoke_id = response.get('InvokeId')
55.     return invoke_id;
57. def get_task_output_by_id(instance_id, invoke_id):
58.     logging.info("Check instance %s invoke_id is %s", instance_id, invoke_id)
59.     request = DescribeInvocationResultsRequest()
60.     request.set_InstanceId(instance_id)
61.     request.set_InvokeId(invoke_id)
62.     response = _send_request(request)
63.     invoke_detail = None
64.     output = None
65.     if response is not None:
66.         result_list = response.get('Invocation').get('InvocationResults').get('InvocationResult')
67.         for item in result_list:
68.             invoke_detail = item
69.             output = base64.b64decode(item.get('Output'))
70.             break;
71.         return output;
73. def execute_command(instance_id):
74.     command_str = 'yum check-update'
75.     command_id = create_command(base64.b64encode(command_str), 'RunShellScript', 'test', 'test')
76.     if(command_id is None):
77.         logging.info('create command failed')
78.         return
80.     invoke_id = invoke_command(instance_id, command_id, 'false', '')
81.     if(invoke_id is None):
82.         logging.info('invoke command failed')
83.         return
85.     time.sleep(15)
87.     output = get_task_output_by_id(instance_id, invoke_id)
88.     if(output is None):
89.         logging.info('get result failed')
90.         return
92.     logging.info("output: %s is \n", output)
94. # send open api request
95. def _send_request(request):
96.     request.set_accept_format('json')
97.     try:
98.         response_str = clt.do_action(request)
99.         logging.info(response_str)
100.         response_detail = json.loads(response_str)
101.         return response_detail
102.     except Exception as e:
103.         logging.error(e)
105. if __name__ == '__main__':
106.     execute_command('i-bp17zhpbXXXXXXXXXXXXX')

• StopInvocation：停止正在进行的命令进程
• ModifyCommand：修改已创建的命令的内容
• DescribeCommands：查询您已经创建的命令
• DeleteCommand：删除已创建的命令