本文档主要介绍运维编排 Python SDK 的安装和使用,适用于 1.0 版本。请确保您已经开通了阿里云运维编排服务,并创建了 AccessKeyId 和 AccessKeySecret。
如果您还没有开通或者还不了解阿里云运维编排服务,请登录运维编排的产品主页进行了解。 如果您还没有创建 AccessKeyId 和 AccessKeySecret,请到阿里云 Access Key 的管理控制台创建 Access Key。
源码地址 请访问 GitHub 获取源码。
本文介绍如何安装Python SDK。
环境准备 适用于 Python 2 和 Python 3。
安装 通过pip安装 执行命令如下:
pip install aliyun-python-sdk-oos 说明 如果您的环境尚未安装pip,请参见pip官网安装。
通过源码安装 从GitHub下载相应版本的SDK包,解压后进入目录,确认目录下有setup.py文件,然后执行命令如下:
python setup.py install
验证 首先命令行输入 python 并回车,在 Python 环境下检查SDK的版本:
import aliyunsdkoos aliyunsdkoos.version '1.0.0' 上面的输出表明您已经成功安装了运维编排服务的 Python SDK 1.0.0。
卸载 执行命令如下:
pip uninstall aliyun-python-sdk-oos
本节介绍如何快速使用OOS Python SDK完成常见操作,如创建模板、启动执行、查询执行等。
创建模板 以下代码用于创建模板:
from aliyunsdkcore.client import AcsClient from aliyunsdkoos.request.v20190601.CreateTemplateRequest import CreateTemplateRequest client = AcsClient(ak=' ', secret=' ', region_id='cn-hangzhou') content = ''' { "FormatVersion": "OOS-2019-06-01", "Description": "Descirbe instances of given status", "Parameters": { "Status": { "Type": "String", "Description": "(Required) The status of the Ecs instance." } }, "Tasks": [ { "Properties": { "Parameters": { "Status": "{{ Status }}" }, "API": "DescribeInstances", "Service": "ECS" }, "Name": "describeInstances", "Action": "ACS::ExecuteAPI" } ] } ''' def create_template(template_name, content): """ 创建模板 """ request = CreateTemplateRequest() request.set_TemplateName(template_name) request.set_Content(content) resp = client.do_action_with_exception(request) return resp resp = create_template(template_name='MyTemplate', content=content) print(resp)
启动执行 以下代码用于启动执行:
import json from aliyunsdkcore.client import AcsClient from aliyunsdkoos.request.v20190601.StartExecutionRequest import StartExecutionRequest client = AcsClient(ak=' ', secret=' ', region_id='cn-hangzhou') def start_execution(template_name, parameters=None): """ 启动执行 """ request = StartExecutionRequest() request.set_TemplateName(template_name) if parameters: parameters = json.dumps(parameters) request.set_Parameters(parameters) resp = client.do_action_with_exception(request) return resp resp = start_execution(template_name='MyTemplate', parameters={"Status":"Running"}) print(resp)
查询执行 以下代码用于查询执行:
from aliyunsdkcore.client import AcsClient from aliyunsdkoos.request.v20190601.ListExecutionsRequest import ListExecutionsRequest client = AcsClient(ak=' ', secret=' ', region_id='cn-hangzhou') def list_exexutions(execution_id=None): """ 查询执行 """ request = ListExecutionsRequest() if execution_id: request.set_ExecutionId(execution_id) resp = client.do_action_with_exception(request) return resp resp = list_exexutions(execution_id=' ') print(resp)
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。