ROS-CLI命令行源码及使用方法整理

参考文章：

<a href="https://yq.aliyun.com/articles/215216?spm=5176.8091938.0.0.9wUCyI">通过命令行工具使用阿里云资源编排服务</a>

<a href="https://help.aliyun.com/document_detail/57847.html?spm=a2c4g.11186623.6.604.4CZyru">阿里云ROS帮助文档——命令行工具使用示例</a>

<code>ros</code> 本身支持如下参数：

命令

功能

<code>-h</code> <code>--help</code>

查看帮助信息

<code>--config [CONFIG_FILE]</code>

使用指定配置文件，如果没有指定，默认使用当前目录下的 <code>ros/ros.conf</code> 作为配置文件

<code>--json</code>

以<code>json</code>格式输出查询信息，否则以阅读格式输出

<code>--region-id [REGION_ID]</code>

指定区域信息，否则使用配置文件中的区域信息

<code>json</code> 格式的输出按照配置文件中的 <code>JSON_INDENT</code> 设置缩进。

<code>ros</code> 支持如下一级命令：

<code>set-userdata</code>

设置默认配置

<code>create-stack</code>

创建堆栈

<code>delete-stack</code>

删除堆栈

<code>update-stack</code>

更新堆栈

<code>preview-stack</code>

预览堆栈

<code>abandon-stack</code>

废弃堆栈（开发中）

<code>list-stacks</code>

列出满足条件的堆栈

<code>describe-stack</code>

列出指定堆栈的详细信息

<code>list-resource</code>

列出指定堆栈的资源信息

<code>describe-resource</code>

列出指定资源的详细信息

<code>resource-type</code>

列出所有资源类型

<code>resource-type-detail</code>

列出指定资源类型的详细信息

<code>resource-type-template</code>

列出指定资源类型的模板信息

<code>get-template</code>

列出指定堆栈的模板信息

<code>validate-template</code>

验证模板信息

<code>list-regions</code>

列出所有区域

<code>list-events</code>

列出满足条件的事件信息

使用 <code>ros abandon-stack</code> 命令废弃堆栈，包含如下参数：

备注

<code>--region-id</code>

指定堆栈所在区域

必须给出

<code>--stack-name [STACK_NAME]</code>

指定堆栈的名称

<code>--stack-id [STACK_ID]</code>

指定堆栈的ID

使用 <code>ros create-stack</code> 命令创建堆栈，包含如下参数：

<code>region-id</code> 将按如下优先级取用：<code>当前命令指定值 &gt; ros 命令指定值 &gt; 配置文件指定值</code>

指定创建堆栈的名称

<code>--template-url [TEMPLATE_URL]</code>

指定创建堆栈的模板文件

必须给出，模板文件内容为 <code>json</code> 格式的模板

<code>--parameters [PARAMETERS]</code>

给出模板需要的参数

与模板中的参数匹配，否则会被服务器拒绝。格式为连续的字符串，形如<code>key1=value1,key2=value2</code>

<code>--disable-rollback [DISABLE_ROLLBACK]</code>

指定回滚策略

默认 <code>true</code> 禁止回滚，

<code>--timeout-in-minutes [TIMEOUT_IN_MINUTES]</code>

指定超时时间

默认 <code>60</code> （分钟）

创建成功后，返回堆栈名称和ID，否则返回错误信息。

使用 <code>ros preview-stack</code> 命令创建堆栈，包含如下参数：

指定预览堆栈的名称

指定预览堆栈的模板文件

使用 <code>ros update-stack</code> 命令更新堆栈，包含如下参数：

指定更新堆栈的名称

指定更新堆栈的ID

指定更新堆栈的模板文件

更新成功后，返回堆栈名称和ID，否则返回错误信息。

使用 <code>ros delete-stack</code> 命令删除堆栈，包含如下参数：

删除成功后，提示成功，无返回值，否则返回错误信息。

使用 <code>ros list-stacks</code> 命令查看堆栈列表，包含如下参数：

<code>--status {CREATE_COMPLETE, CREATE_FAILED, CREATE_IN_PROGRESS, DELETE_COMPLETE, DELETE_FAILED, DELETE_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED, ROLLBACK_IN_PROGRESS}</code>

指定堆栈的状态

必须使用指定值

<code>--page-number [PAGE_NUMBER]</code>

输入查看的页码

查询结果将分页返回，从1开始，默认为1

<code>--page-size [PAGE_SIZE]</code>

指定每页显示数量

默认为10，不超过100

输出当前的翻页情况及结果列表

使用 <code>ros describe-stack</code> 命令获取堆栈详细信息，包含如下参数：

成功后输出堆栈信息，否则输出错误信息。

使用 <code>ros list-resources</code> 命令获取堆栈资源信息，包含如下参数：

成功后输出堆栈资源信息，否则输出错误信息。

使用 <code>ros describe-resource</code> 命令获取堆栈资源信息，包含如下参数：

<code>--resource-name [RESOUCE_NAME]</code>

指定的资源名称

使用 <code>ros resoucre-type</code> 命令获取资源种类信息，包含如下参数：

<code>--status {UNKNOWN, SUPPORTED, DEPRECATED, UNSUPPORTED, HIDDEN}</code>

资源状态

默认使用<code>SUPPORTED</code>

成功后输出资源种类信息。如果没有符合要求的，无输出。

使用 <code>ros resource-type-detail</code> 命令获取资源种类信息，包含如下参数：

<code>--name [NAME]</code>

指定资源类型的名称

成功后返回资源详细信息，否则输出错误信息。

使用 <code>ros resource-type-template</code>命令获取资源种类模板，包含如下参数：

成功后返回资源模板信息，否则输出错误信息。

使用 <code>ros get-template</code> 命令获取指定堆栈的模板，包含如下参数：

获取成功后，输出模板，否则输出错误信息。

使用 <code>ros validate-template</code> 命令验证指定堆栈的模板，包含如下参数：

指定模板地址

列出所有的区域，无需参数。

使用 <code>ros list-events</code> 命令查看事件列表，包含如下参数：

<code>--resource-status {'COMPLETE', 'FAILED', 'IN_PROGRESS'}</code>

指定资源的状态

<code>--resource-name</code>

指定筛选资源

<code>--resource-type</code>

指定筛选资源类型

使用 <code>set-userdata</code> 命令设置默认的用户配置。

<code>--key-id [KEY_ID]</code>

默认的 ALIYUN Access Key ID

<code>--key-secret [KEY_SECRET]</code>

默认的 ALIYUN Access Key Secret

默认的 region-id

<code>--json-indent [JSON_INDENT]</code>

JSON输出时的缩进