全部产品
云市场

CLI参考

更新时间:2019-07-03 19:02:55

CLI 参考

本节介绍如何使用阿里云CLI调用运维编排服务的API,请确保您已安装配置了阿里云CLI,且版本号大于等于 3.0.19。

本示例通过阿里云CLI调用API,完成创建模板、启动执行、查询执行等任务。调用API前,请根据API文档了解使用说明,并查询必需的请求参数。调用API报错时,您可以在相应API文档中获取排查建议。

创建模板

指定模板名称和内容来创建模板:

  1. aliyun oos CreateTemplate --region cn-hangzhou --TemplateName MyTemplate --Content '{"FormatVersion": "OOS-2019-06-01", "Tasks": [{"Action": "ACS::ExecuteApi", "Properties": {"API": "DescribeInstances", "Service": "Ecs", "Parameters": {"Status": "{{ Status }}"}}, "Name": "foo"}], "Description": "Descirbe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}}'

启动执行

使用模板MyTemplate来启动执行:

  1. aliyun oos StartExecution --region cn-hangzhou --TemplateName MyTemplate --Parameters '{"Status":"Running"}'

查询执行

根据上一步返回的ExecutionId,查询该执行的结果:

  1. aliyun oos ListExecutions --region cn-hangzhou --ExecutionId "<ExecutionId>"

公共请求参数

名称 示例值 描述
Action CreateTemplate CLI调用的OOS Open Api名称,具体请参考Api概览
region cn-hangzhou API 网关所在地域唯一标识,具体参考OOS支持的Region列表