すべてのプロダクト
Search
ドキュメントセンター

Simple Application Server:RunCommand

最終更新日:Dec 21, 2025

Simple Application Server 上でコマンドを実行します。

操作説明

クラウドアシスタントは、Simple Application Server の自動 O&M ツールです。 サーバーにリモートログインすることなく、Simple Application Server コンソールでシェル、PowerShell、およびバッチコマンドを実行して、Simple Application Server をメンテナンスできます。

クラウドアシスタントを使用する前に、次の項目にご注意ください:

  • Simple Application Server は実行中状態である必要があります。

  • サーバーにクラウドアシスタントクライアントがインストールされている必要があります。 デフォルトでは、クラウドアシスタントクライアントは Simple Application Server にインストールされています。 クライアントを手動でアンインストールした場合は、再インストールする必要があります。 詳細については、「クラウドアシスタントエージェントのインストール」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:RunCommand

create

*Command

acs:swas-open:{#regionId}:{#accountId}:{#CommandId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

CommandContent

string

必須

コマンドの内容です。 次の項目にご注意ください:

  • EnableParameter を true に設定すると、コマンド内容でカスタムパラメーター機能が有効になり、次のルールに基づいてカスタムパラメーターを設定できます:

  • カスタムパラメーターは {{}} 形式で定義します。 {{}} 内では、パラメーター名の前後のスペースと改行は無視されます。

  • カスタムパラメーターの数は 20 を超えることはできません。

  • カスタムパラメーター名には、文字、数字、アンダースコア (_)、ハイフン (-) のみを含めることができます。 名前では大文字と小文字は区別されません。

  • 各カスタムパラメーター名の長さは 64 バイトを超えることはできません。

ifconfig -s

WorkingDir

string

任意

コマンドの実行パスです。 カスタムパスがサポートされています。 デフォルトの実行パスは、サーバーのオペレーティングシステムによって異なります。

  • Linux サーバーの場合、デフォルトのパスは root ユーザーの /root です。

  • Windows サーバーの場合、デフォルトのパスは C:\Windows\system32 です。

/home/

RegionId

string

必須

Simple Application Server のリージョン ID です。 ListRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

cn-hangzhou

Timeout

integer

任意

サーバー上でのコマンドのタイムアウト期間です。

コマンド実行タスクがタイムアウトした場合、クラウドアシスタントはタスクプロセスを強制的に終了させます。 有効値:10~86400。 単位:秒。 86400 秒は 24 時間に相当します。

デフォルト値:60。

60

Type

string

必須

コマンドの言語タイプです。 有効値:

  • RunBatScript:バッチコマンド (Windows サーバーに適用)。

  • RunPowerShellScript:PowerShell コマンド (Windows サーバーに適用)。

  • RunShellScript:シェルコマンド (Linux サーバーに適用)。

RunShellScript

EnableParameter

boolean

任意

カスタムパラメーター機能を有効にするかどうかを指定します。

デフォルト値:false。

false

Parameters

object

任意

コマンドにカスタムパラメーターが含まれている場合に渡される、キーと値のペア形式のカスタムパラメーターです。 たとえば、コマンドの内容が echo {{name}} の場合、Parameters を使用して {"name":"Jack"} のキーと値のペアを渡すことができます。 カスタムパラメーターの name キーは、ペアになっている Jack の値に自動的に置き換えられ、新しいコマンドが生成されます。 結果として、echo Jack コマンドが実行されます。

最大 20 個のカスタムパラメーターを指定できます。 次の項目にご注意ください:

  • カスタムパラメーターのキーの長さは最大 64 文字で、空の文字列にすることはできません。

  • カスタムパラメーターの値は空の文字列にすることができます。

  • Base64 エンコーディング後のコマンドのサイズ (カスタムパラメーターと元のコマンド内容を含む) は 16 KB を超えることはできません。

  • Parameters で指定されたカスタムパラメーター名は、コマンド作成時に指定したカスタムパラメーター名に含まれている必要があります。 渡されないパラメーターを表すには、空の文字列を使用できます。

このパラメーターはデフォルトで空のままです。これは、カスタムパラメーター機能が無効になっていることを示します。

{"name":"Jack", "accessKey":"LTAI****************"}

WorkingUser

string

任意

コマンドを実行するサーバーのユーザーです。 セキュリティリスクを軽減するために、一般ユーザーとしてコマンドを実行することを推奨します。 デフォルト値:

  • Linux サーバーの場合、デフォルト値は root です。

  • Windows サーバーの場合、デフォルト値は system です。

root

WindowsPasswordName

string

任意

Windows Simple Application Server でコマンドを実行するために使用されるパスワードの名前です。

デフォルトの "system" ユーザー名以外のユーザー名を使用して Windows サーバーでコマンドを実行する場合は、WindowsPasswordName と WorkingUser の両方のパラメーターを指定する必要があります。 パスワードは、パスワード漏洩のリスクを軽減するために、CloudOps Orchestration Service (OOS) のパラメーターリポジトリにプレーンテキストでホストされます。 WindowsPasswordName を使用してパスワードの名前のみが渡されます。

axtSecretPassword

InstanceId

string

必須

Simple Application Server の ID です。

ace0706b2ac4454d984295a94213****

Name

string

必須

コマンドの名前です。

testName

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID です。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

InvokeId

string

実行 ID です。

t-hz02p9545t6****

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "InvokeId": "t-hz02p9545t6****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。