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輸出時的縮進