CloudOps Orchestration Service:Alibaba Cloud CLI との統合

使用する前に、Alibaba Cloud CLI をインストールする必要があります。 Alibaba Cloud CLI は、Windows、Linux、および macOS オペレーティングシステムにインストールできます。デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLI のインストールパッケージを選択してください。詳細については、以下のトピックをご参照ください。

• Windows オペレーティングシステム: Windows

• Linux オペレーティングシステム: Linux

• macOS オペレーティングシステム: macOS

Alibaba Cloud が提供する Cloud Shell を使用して、Alibaba Cloud CLI で実行するコマンドをデバッグすることもできます。 Cloud Shell の詳細については、「Cloud Shell とは」をご参照ください。

構文

Alibaba Cloud CLI では、次の構文を使用してコマンドを実行できます。詳細については、「CLI コマンドの生成と実行」トピックの「構文」セクションをご参照ください。

aliyun <command> <subcommand> [options and parameters]

一般的なコマンドオプション

サンプルコード

サンプル 1: 次のサンプルコードは、--help オプションを使用して、Alibaba Cloud CLI でサポートされている CloudOps Orchestration Service API 操作のリストを取得する方法を示しています。 関数別の操作リスト で呼び出すことができる API 操作を表示することもできます。

1. 次のコマンドを実行します。

   aliyun oos --help

2. 結果を表示します。

   

サンプル 2: 次のサンプルコードは、Alibaba Cloud CLI を使用して OOS の CreateTemplate 操作を呼び出し、CLI_Template という名前のテンプレートを作成する方法を示しています。

1. 次のコマンドを実行します。

   説明

   文字列型 JSON 配列リストパラメーターの入力形式は、オペレーティングシステムによって異なります。オペレーティングシステムに基づいて、対応するコマンドを選択して実行してください。詳細については、「パラメーター形式」をご参照ください。

   Linux/macOS

   aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe 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": "foo", "Action": "ACS::ExecuteApi"}]}'

   Windows

   aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe 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': 'foo', 'Action': 'ACS::ExecuteApi'}]}"

2. 結果を表示します。

   {
     "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485",
     "Template": {
       "Description": "Describe instances of given status",
       "CreatedBy": "test(2039927162697*****)",
       "TemplateFormat": "JSON",
       "ResourceGroupId": "rg-acfmykd6*****",
       "UpdatedDate": "2024-08-05T10:28:24Z",
       "TemplateVersion": "v1",
       "Hash": "8abc5921b5a05051992*****",
       "UpdatedBy": "test(2039927162697*****)",
       "HasTrigger": false,
       "CreatedDate": "2024-08-05T10:28:24Z",
       "TemplateName": "CLI_Template",
       "Tags": {},
       "TemplateId": "t-9246d5246f*****",
       "ShareType": "Private"
     }
   }

   説明

   CloudOps Orchestration Service の API 操作の呼び出し後にエラーが返された場合は、エラーコードに基づいて入力パラメーターと値が有効かどうかを確認してください。

   Alibaba Cloud OpenAPI Diagnostics を使用して、返されたリクエスト ID またはエラー情報に基づいてセルフサービス診断を実行することもできます。