全部产品
阿里云办公

弹性管理 ECS 实例

更新时间:2017-12-29 15:33:38

您除了可以通过 ECS管理控制台 创建或管理ECS实例外,您也能通过 API 管理或定制开发 ECS 实例。

阿里云提供了 SDK 来包装API,将云服务器 ECS 的管理集成到已有系统中。本文基于 Python 的开发来说明如何通过API 管理 ECS 实例。如果您没有 Python 开发经验,也能通过本文完成云服务的开发。

获取 RAM 子账号 AK 密钥

使用API管理ECS实例,您需要能访问ECS资源的API密钥(AccessKey ID 和 AccessKey Secret)。为了保证云服务的安全,您需要创建一个能访问ECS资源的RAM用户,获取该用户的AccessKey密钥,并使用这个RAM用户和API管理ECS实例。

以下是获取RAM用户AccessKey密钥的操作步骤:

  1. 创建RAM用户并获取AccessKey密钥
  2. 直接给RAM用户授权,授予RAM用户 管理云服务器服务(ECS)的权限

安装 ECS Python SDK

首先确保您已经具备Python的Runtime,本文中使用的Python版本为2.7+。

  1. pip install aliyun-python-sdk-ecs

如果提示您没有权限,请切换sudo继续执行。

  1. sudo pip install aliyun-python-sdk-ecs

本文使用的SDK版本为 2.1.2

Hello Alibaba Cloud

创建文件 hello_ecs_api.py。为了使用SDK,首先实例化AcsClient对象,这里需要RAM用户的AccessKey ID和AccessKey Secret。

AccessKey ID和AccessKey Secret是RAM用户访问阿里云ECS服务API的密钥,具有该账户完全的权限,请妥善保管。

  1. from aliyunsdkcore import client
  2. from aliyunsdkecs.request.v20140526.DescribeInstancesRequest import DescribeInstancesRequest
  3. from aliyunsdkecs.request.v20140526.DescribeRegionsRequest import DescribeRegionsRequest
  4. clt = client.AcsClient('Your Access Key Id', 'Your Access Key Secrect', 'cn-beijing')

完成实例化后可以进行第一个应用的开发。查询当前账号支持的地域列表。具体的文档参见 查询可用地域列表

  1. def hello_aliyun_regions():
  2. request = DescribeRegionsRequest()
  3. response = _send_request(request)
  4. region_list = response.get('Regions').get('Region')
  5. assert response is not None
  6. assert region_list is not None
  7. result = map(_print_region_id, region_list)
  8. logging.info("region list: %s", result)
  9. def _print_region_id(item):
  10. region_id = item.get("RegionId")
  11. return region_id
  12. def _send_request(request):
  13. request.set_accept_format('json')
  14. try:
  15. response_str = clt.do_action(request)
  16. logging.info(response_str)
  17. response_detail = json.loads(response_str)
  18. return response_detail
  19. except Exception as e:
  20. logging.error(e)
  21. hello_aliyun_regions()

在命令行运行 python hello_ecs_api.py 会得到当前支持的 Region列表。类似的输出如下:

  1. [u'cn-shenzhen', u'ap-southeast-1', u'cn-qingdao', u'cn-beijing', u'cn-shanghai', u'us-east-1', u'cn-hongkong', u'me-east-1', u'ap-southeast-2', u'cn-hangzhou', u'eu-central-1', u'ap-northeast-1', u'us-west-1']

查询当前的 Region 下的 ECS 实例列表

查询实例列表和查询 Region 列表非常类似,替换入参对象为DescribeInstancesRequest 即可,更多的查询参数参考 查询实例列表

  1. def list_instances():
  2. request = DescribeInstancesRequest()
  3. response = _send_request(request)
  4. if response is not None:
  5. instance_list = response.get('Instances').get('Instance')
  6. result = map(_print_instance_id, instance_list)
  7. logging.info("current region include instance %s", result)
  8. def _print_instance_id(item):
  9. instance_id = item.get('InstanceId');
  10. return instance_id

输出结果为如下:

  1. current region include instance [u'i-****', u'i-****'']

更多的API参考 ECS API 概览,您可以尝试作一个 查询磁盘列表,将实例的参数替换为 DescribeDisksRequest

完整代码示例

以上操作完整的代码示例如下所示。

  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. from aliyunsdkcore import client
  8. from aliyunsdkecs.request.v20140526.DescribeInstancesRequest import DescribeInstancesRequest
  9. from aliyunsdkecs.request.v20140526.DescribeRegionsRequest import DescribeRegionsRequest
  10. # configuration the log output formatter, if you want to save the output to file,
  11. # append ",filename='ecs_invoke.log'" after datefmt.
  12. logging.basicConfig(level=logging.INFO,
  13. format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
  14. datefmt='%a, %d %b %Y %H:%M:%S')
  15. clt = client.AcsClient('Your Access Key Id', 'Your Access Key Secrect', 'cn-beijing')
  16. # sample api to list aliyun open api.
  17. def hello_aliyun_regions():
  18. request = DescribeRegionsRequest()
  19. response = _send_request(request)
  20. if response is not None:
  21. region_list = response.get('Regions').get('Region')
  22. assert response is not None
  23. assert region_list is not None
  24. result = map(_print_region_id, region_list)
  25. logging.info("region list: %s", result)
  26. # output the instance owned in current region.
  27. def list_instances():
  28. request = DescribeInstancesRequest()
  29. response = _send_request(request)
  30. if response is not None:
  31. instance_list = response.get('Instances').get('Instance')
  32. result = map(_print_instance_id, instance_list)
  33. logging.info("current region include instance %s", result)
  34. def _print_instance_id(item):
  35. instance_id = item.get('InstanceId');
  36. return instance_id
  37. def _print_region_id(item):
  38. region_id = item.get("RegionId")
  39. return region_id
  40. # send open api request
  41. def _send_request(request):
  42. request.set_accept_format('json')
  43. try:
  44. response_str = clt.do_action(request)
  45. logging.info(response_str)
  46. response_detail = json.loads(response_str)
  47. return response_detail
  48. except Exception as e:
  49. logging.error(e)
  50. if __name__ == '__main__':
  51. logging.info("Hello Aliyun OpenApi!")
  52. hello_aliyun_regions()
  53. list_instances()

如您想了解 ECS 中 API 的其它操作,请参考 ECS中的API操作