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

Simple Application Server:DescribeInvocations

最終更新日:Dec 21, 2025

コマンドの実行詳細を照会します。

操作説明

  • コマンドを実行した後、コマンドが成功しなかったり、期待どおりの結果が返されなかったりする場合があります。この操作を呼び出して、実際の実行結果を照会できます。

  • 過去 2 週間以内に生成された実行結果を照会できます。最大 100,000 件の実行結果を保持できます。

今すぐお試しください

この 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:DescribeInvocations

get

*Instance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

シンプルアプリケーションサーバーが所在するリージョン ID。 ListRegions 操作を呼び出して、最新のリージョンリストを照会できます。

cn-hangzhou

InstanceId

string

必須

シンプルアプリケーションサーバーの ID。

3a658ca270df4df39f22e289b338****

PageNumber

integer

任意

ページ番号。

ページは 1 から始まります。

デフォルト値:1。

1

PageSize

integer

任意

1 ページあたりのエントリ数。

最大値:50。

デフォルト値:10。

10

InvokeStatus

string

任意

コマンドの実行ステータス。有効な値:

  • Running:コマンドは実行中です。

  • Finished:実行は完了しました。

  • Failed:実行は失敗しました。

Finished

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

RequestId

string

リクエスト ID。

30637AD6-D977-4833-A54C-CC89483E****

Invocations

array<object>

コマンド名。

array<object>

CreationTime

string

コマンドが作成された時間。

2022-07-11T06:37:16Z

InvocationStatus

string

コマンドのステータス。有効な値:

  • Pending:コマンドは検証中または送信中です。

  • Invalid:指定されたコマンドタイプまたはパラメーターが無効です。

  • Aborted:コマンドの送信に失敗しました。インスタンスにコマンドを送信するには、インスタンスが実行中 (Running) 状態であり、コマンドが 1 分以内にインスタンスに送信されることを確認してください。

  • Running:コマンドはインスタンスで実行中です。

  • Success:コマンドの実行が完了し、終了コードは 0 です。

  • Failed:コマンドの実行は完了しましたが、終了コードは 0 ではありません。

  • Error:例外により、コマンドの実行を続行できません。

  • Timeout:コマンドの実行がタイムアウトしました。

  • Cancelled:実行がキャンセルされ、コマンドは実行されませんでした。

  • Stopping:実行中のコマンドは停止中です。

  • Terminated:実行中にコマンドが終了されました。

Success

CommandType

string

コマンドのタイプ。有効な値:

  • RunBatScript:バッチコマンド (Windows インスタンスに適用)。

  • RunPowerShellScript:PowerShell コマンド (Windows インスタンスに適用)。

  • RunShellScript:シェルコマンド (Linux インスタンスに適用)。

RunShellScript

CommandContent

string

Base64 エンコードされたコマンドの内容。

bHM=

Parameters

object

コマンド内のカスタムパラメーター。コマンドにカスタムパラメーターが存在しない場合、デフォルト値は {} です。

{}

InvokeStatus

string

コマンドのステータス。有効な値:

  • Running:コマンドは実行中です。

  • Finished:コマンドの実行が完了しました。

  • Failed:コマンドの実行に失敗しました。

  • Stopped:実行が停止されました。

Finished

InvokeId

string

コマンドタスクの ID。

t-hz02p9545t6****

CommandName

string

コマンドの名前。

testname

PageSize

integer

1 ページあたりのエントリ数。

10

PageNumber

integer

ページ番号。

1

TotalCount

integer

返されたエントリの総数。

10

成功レスポンス

JSONJSON

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "Invocations": [
    {
      "CreationTime": "2022-07-11T06:37:16Z",
      "InvocationStatus": "Success",
      "CommandType": "RunShellScript",
      "CommandContent": "bHM=",
      "Parameters": {},
      "InvokeStatus": "Finished",
      "InvokeId": "t-hz02p9545t6****",
      "CommandName": "testname"
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 10
}

エラーコード

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

変更履歴

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