すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeInvocationResults

    ドキュメントセンター

    Elastic Compute Service:DescribeInvocationResults

    最終更新日:Sep 22, 2026

    1 つ以上のクラウドアシスタントコマンドの実行結果 (ECS インスタンス上での実際の実行結果) を照会します。

    操作説明

    操作の説明

    • コマンド (スクリプト) を実行した後、コマンドが成功することや期待される結果が得られることは保証されません。この操作を呼び出して、実際の出力に基づいた実行結果を確認してください。

    • 過去 30 日間の実行情報をクエリできます。最大 10,000 件の実行情報が保持されます。

    • クラウドアシスタントタスクステータスイベントサブスクリプション を使用して、イベントを通じてタスク結果を取得できます。これにより、頻繁なポーリングを回避し、効率を向上させることができます。

    • 最初のページをページングクエリする場合、返されるエントリ数を制限するために MaxResults のみを設定します。応答内の NextToken 値は、後続のページをクエリするためのトークンとして使用されます。後続のページをページングクエリする場合、NextToken を前の応答から取得した NextToken 値に設定し、MaxResults を設定して返されるエントリ数を制限します。

    • DescribeInvocations と DescribeInvocationResults の違い:

      • 単一の RunCommand/InvokeCommand 呼び出しで複数のインスタンスを指定する場合:

        • DescribeInvocations は、各インスタンスでの実行ステータスと、複数のインスタンスにまたがる集約ステータスを返します。

        • DescribeInvocationResults は、各インスタンスでの個別の実行ステータスのみを返し、複数のインスタンスにまたがる集約ステータスは返しません。

      • 単一の RunCommand/InvokeCommand 呼び出しで 1 つのインスタンスを指定する場合:

        • DescribeInvocations と DescribeInvocationResults はほぼ互換性があります。

      • スケジュールされた (期間) タスクまたは各システム起動時に実行されるタスク (RepeatMode=Period, EveryReboot) の実行履歴を確認する必要がある場合、DescribeInvocationResults のみが過去の実行レコードを返すことができます (IncludeHistory=true を指定する必要があります)。DescribeInvocations は最新のタスクステータスのみを返します。

      • コマンドの内容またはパラメーターを確認する必要がある場合、DescribeInvocations のみが CommandContent を返します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribeInvocationResults

    get

    Command。

    acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

    Instance。

    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    コマンド実行のリソースグループ ID。このパラメーターを指定した後、コマンドを実行する際にもリソースグループ ID を指定する必要があります。このパラメーターは、対応するコマンド実行結果をフィルター処理するために使用されます。

    rg-bp67acfmxazb4p****
    InvokeId

    string

    任意

    コマンド実行 ID。 DescribeInvocations を呼び出して、InvokeId をクエリできます。

    t-hz0jdfwd9f****
    InstanceId

    string

    任意

    インスタンス ID

    i-bp1i7gg30r52z2em****
    CommandId

    string

    任意

    コマンド ID。

    c-hz0jdfwcsr****
    InvokeRecordStatus

    string

    任意

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

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

      • スケジュール実行: スケジュールされたコマンドを手動で停止するまで、実行ステータスは実行中のままです。

      • 1 回限りの実行 (1 回の時間): いずれかのコマンドプロセスが実行中である限り、全体的な実行ステータスは実行中です。

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

      • スケジュール実行: コマンドプロセスの状態が Finished になることはありません。

      • 1 回限りの実行 (1 回の時間): すべてのインスタンスで実行が完了したか、一部のインスタンスでコマンドプロセスを手動で停止し、残りのインスタンスで実行が完了しました。

    • Success:

      • 1 回限りの実行 (1 回の時間): コマンドの実行が完了し、終了コードが 0 です。

      • スケジュール実行: 最後の実行が終了コード 0 で成功し、指定された実行時間が終了しました。

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

      • スケジュール実行: コマンドプロセスの状態が Failed になることはありません。

      • 1 回限りの実行 (1 回の時間): すべてのインスタンスでコマンドの実行に失敗しました。

    • PartialFailed: コマンドの実行が部分的に失敗しました。

      • スケジュール実行: コマンドプロセスの状態が PartialFailed になることはありません。

      • 1 回限りの実行 (1 回の時間): 一部のインスタンスでコマンドプロセスが失敗したため、全体的な実行ステータスは部分的な失敗です。

    • Stopped: コマンドの実行が停止されました。

    • Stopping: コマンドの実行が停止されています。

    Running
    IncludeHistory

    boolean

    任意

    スケジュールされたコマンド実行回数の履歴レコードを返すかどうかを指定します。有効な値:

    • true: スケジュールされたコマンド実行回数の結果を返します。このパラメーターが true にセットされている場合、InvokeId パラメーターは空にできず、スケジュールされたコマンド (RepeatMode が Period) または各システム起動時に実行されるコマンド (RepeatMode が EveryReboot) の実行 ID である必要があります。

    • false: 履歴を返しません。

    デフォルト値: false。

    false
    ContentEncoding

    string

    任意

    応答内の CommandContent フィールドおよび Output フィールドのエンコーディングタイプ。有効な値:

    • PlainText: 元のコマンド内容と出力を返します。

    • Base64: Base64 でエンコードされたコマンド内容と出力を返します。

    デフォルト値: Base64。

    PlainText
    PageNumber

    integer

    任意

    説明

    このパラメーターはまもなく非推奨になります。ページングクエリを実行するには、NextToken と MaxResults を使用してください。

    1
    PageSize

    integer

    任意

    説明

    このパラメーターはまもなく非推奨になります。ページングクエリを実行するには、NextToken と MaxResults を使用してください。

    1
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりの最大エントリ数。

    最大値: 50。

    デフォルト値: 10。

    10
    NextToken

    string

    任意

    ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。

    AAAAAdDWBF2
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    コマンド実行のタグキー。N の有効な値: 1～20。タグキーは空の文字列にできません。

    単一のタグを使用してリソースをフィルター処理する場合、このタグを持つリソースの数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、指定されたすべてのタグが付けられたリソースの数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources を呼び出してリソースをクエリしてください。

    タグキーの長さは最大 64 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    TestKey
    Value

    string

    任意

    コマンド実行のタグ値。N の有効な値: 1～20。タグ値は空の文字列にできます。

    タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。

    TestValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Invocation

    object

    コマンド実行結果のコレクション。

    InvocationResults

    object

    InvocationResult

    array<object>

    コマンド実行結果セット。

    array<object>

    CommandId

    string

    コマンド ID。

    c-hz0jdfwcsr****
    ContainerId

    string

    コンテナ ID。

    ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
    ContainerName

    string

    コンテナ名。

    test-container
    Dropped

    integer

    Output フィールドの長さが 24 KB を超えた場合に切り捨てられて破棄されたテキストのサイズ。

    0
    ErrorCode

    string

    コマンドの配信または実行が失敗した際のエラーコード。有効な値:

    • Empty: コマンドは正常に実行されました。

    • InstanceNotExists: 指定されたインスタンスが存在しないか、リリースされています。

    • InstanceReleased: コマンドの実行中にインスタンスがリリースされました。

    • InstanceNotRunning: コマンドの実行時にインスタンスが実行状態ではありませんでした。

    • CommandNotApplicable: コマンドは指定されたインスタンスに適用できません。

    • AccountNotExists: コマンド実行用に指定されたユーザー名が存在しません。

    • DirectoryNotExists: 指定されたディレクトリが存在しません。

    • BadCronExpression: 実行スケジュール用に指定された cron 式が無効です。

    • ClientNotRunning: クラウドアシスタントエージェントが実行されていません。

    • ClientNotResponse: クラウドアシスタントエージェントが応答していません。

    • ClientIsUpgrading: クラウドアシスタントエージェントがアップグレード中です。

    • ClientNeedUpgrade: クラウドアシスタントエージェントをアップグレードする必要があります。

    • DeliveryTimeout: コマンドの配信がタイムアウトしました。

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

    • ExecutionException: コマンドの実行中に例外が発生しました。

    • ExecutionInterrupted: コマンドの実行が中断されました。

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

    • SecurityGroupRuleDenied: セキュリティグループルールによってクラウドアシスタントサービスへのアクセスが拒否されました。

    • TaskConcurrencyLimit: 同時実行されるタスクの数が最大クォータを超えました。

    InstanceNotExists
    ErrorInfo

    string

    コマンド配信失敗または実行失敗の詳細な理由。有効な値:

    • Empty: コマンドは正常に実行されました。

    • The security group rules denied access to the aliyun service: セキュリティグループルールによってクラウドアシスタントサービスへのアクセスが拒否されました。

    • The specified instance does not exist: 指定されたインスタンスが存在しないか、リリースされています。

    • The specified instance was released during task execution: タスク実行中にインスタンスがリリースされました。

    • The specified instance was not running during task execution: タスク実行中にインスタンスが実行状態ではありませんでした。

    • The OS type of the instance does not support the specified command type: コマンドは指定されたインスタンスに該当なし。

    • The specified account does not exist: 指定されたアカウントが存在しません。

    • The specified directory does not exist: 指定されたディレクトリが存在しません。

    • The cron expression is invalid: 指定された cron 式が無効です。

    • The aliyun service is not running on the instance: クラウドアシスタントエージェントが実行されていません。

    • The aliyun service in the instance does not response: クラウドアシスタントエージェントが応答していません。

    • The aliyun service in the instance is upgrading during task execution: タスク実行中にクラウドアシスタントエージェントがアップグレード中です。

    • The aliyun service in the instance need to be upgraded to at least version <version> to support the <feature> feature: クラウドアシスタントエージェントをアップグレードする必要があります。<version> はサポートされる最小値バージョンを示し、<feature> は特定の特徴を示します。

    • The command delivery has been timeout: コマンドの配信がタイムアウトしました。

    • The command execution has been timeout: コマンドの実行がタイムアウトしました。

    • The command execution got an exception: コマンドの実行中に例外が発生しました。

    • The command execution exit code is not zero: コマンドの実行が完了しましたが、終了コードが 0 ではありません。

    • The specified instance was released during task execution: タスク実行中にインスタンスがリリースされました。

    the specified instance does not exists
    ExitCode

    integer

    コマンドの終了コード。

    • Linux インスタンスの場合、シェルコマンドの終了コードです。

    • Windows インスタンスの場合、Bat または PowerShell コマンドの終了コードです。

    0
    FinishedTime

    string

    コマンドの実行が完了した時間。コマンドの実行がタイムアウトした場合、完了時間は StartTime にコマンドのタイムアウト時間 Timeout を加えたものとして計算されます。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:56Z
    InstanceId

    string

    インスタンス ID

    i-bp1i7gg30r52z2em****
    InvocationStatus

    string

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

    • Pending: システムがコマンドを検証または送信しています。

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

    • Aborted: インスタンスへのコマンドの送信に失敗しました。インスタンスは実行状態である必要があり、コマンドは 1 分以内に配信可能である必要があります。

    • Running: インスタンスでコマンドが実行されています。

    • Success:

      • 1 回限りの実行: コマンドの実行が完了し、終了コードが 0 です。

      • スケジュール実行: 最後の実行が終了コード 0 で成功し、指定された実行時間が終了しました。

    • Failed:

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

      • スケジュール実行: 最後の実行が 0 以外の終了コードで完了し、指定された実行時間が終了しました。

    • Error: コマンドの実行中に例外が発生し、コマンドを続行できません。

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

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

    • Stopping: コマンドの実行が停止されています。

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

    • Scheduled:

      • 1 回限りの実行: 該当なし。この値は表示されません。

      • スケジュール実行: 実行待ち。

    Success
    InvokeId

    string

    コマンド実行 ID。

    t-hz0jdfwd9f****
    InvokeRecordStatus

    string

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

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

      • スケジュール実行: スケジュールされたコマンドを手動で停止するまで、実行ステータスは実行中のままです。

      • 1 回限りの実行: いずれかのコマンドプロセスが実行中である限り、全体的な実行ステータスは実行中です。

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

      • スケジュール実行: コマンドプロセスの状態が Finished になることはありません。

      • 1 回限りの実行: すべてのインスタンスで実行が完了したか、一部のインスタンスでコマンドプロセスを手動で停止し、残りのインスタンスで実行が完了しました。

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

      • スケジュール実行: コマンドプロセスの状態が Failed になることはありません。

      • 1 回限りの実行: すべてのインスタンスでコマンドの実行に失敗しました。

    • PartialFailed: コマンドの実行が部分的に失敗しました。

      • スケジュール実行: コマンドプロセスの状態が PartialFailed になることはありません。

      • 1 回限りの実行: 一部のインスタンスでコマンドプロセスが失敗したため、全体的な実行ステータスは部分的な失敗です。

    • Stopped: コマンドの実行が停止されました。

    • Stopping: コマンドの実行が停止されています。

    Running
    Launcher

    string

    スクリプト実行のブートストラッププログラム。値の長さは最大 1 KB です。

    python3 -u {{ACS::ScriptFileName|Ext(".py")}}
    OssOutputDelivery

    string

    コマンド実行出力の OSS 配信構成。

    oss://testBucket/testPrefix
    OssOutputErrorCode

    string

    配信失敗時のエラーコード。このパラメーターは、OssOutputStatus が Failed の場合にのみ返されます。 有効な値:

    • CloudAssistant.UnsupportedInvocationStatus: タスクステータスは配信をサポートしていません。

    • CloudAssistant.ClientNeedUpgrade: クラウドアシスタントエージェントのバージョンは配信をサポートしていません。クラウドアシスタントエージェントのバージョンは、Linux インスタンスの場合は 2.2.4.1007 以降、Windows インスタンスの場合は 2.1.4.1007 以降である必要があります。

    • OSS.AccessDenied: ユーザーに指定されたバケットへのアクセス権限がありません。

    • OSS.NoSuchBucket: 指定されたバケットが存在しません。

    • OSS.FileImmutable: バケット内のデータは保護状態です。

    • OSS.InvalidObjectName: オブジェクト名が要件を満たしていません。これには、指定されていないオブジェクト名、長さの制限を超えるオブジェクト名、または無効なオブジェクト名が含まれます。

    CloudAssistant.UnsupportedInvocationStatus
    OssOutputErrorInfo

    string

    配信失敗時のエラーの詳細。このパラメーターは、OssOutputStatus が Failed の場合にのみ返されます。

    The invocation status does not support output delivery
    OssOutputStatus

    string

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

    • InProgress: 配信中です。

    • Finished: 配信が完了しました。

    • Failed: 配信に失敗しました。

    Finished
    OssOutputUri

    string

    コマンド実行出力のために OSS に配信されたファイルの URI。配信が失敗した場合または配信中の場合、このフィールドは空の文字列です。

    oss://testBucket/testPrefix/output.txt
    Output

    string

    コマンド実行の出力。

    • ContentEncoding が PlainText に設定されている場合、元の出力が返されます。

    • ContentEncoding が Base64 に設定されている場合、Base64 でエンコードされた出力が返されます。

    MTU6MzA6MDEK
    Repeats

    integer

    インスタンスでコマンドが実行された回数。

    • 実行モードが 1 回限りの実行の場合、値は 0 または 1 です。

    • 実行モードがスケジュール実行の場合、値はコマンドが実行された回数です。

    0
    StartTime

    string

    インスタンスでコマンドの実行が開始された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:55Z
    StopTime

    string

    コマンドの実行を停止するための StopInvocation の呼び出し時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2020-01-19T09:15:47Z
    Tags

    object

    Tag

    array<object>

    コマンド実行のタグ情報。

    object

    コマンド実行のタグ情報。

    TagKey

    string

    コマンド実行のタグキー。

    owner
    TagValue

    string

    コマンド実行のタグ値。

    zhangsan
    TerminationMode

    string

    タスクが停止される際 (手動で停止されたか、タイムアウトにより中断されたか) に使用されるモード。有効な値:

    • Process: 現在のスクリプトプロセスを停止します。

    • ProcessTree: 現在のプロセスツリー (スクリプトプロセスとそれが作成したすべての子プロセス) を停止します。

    ProcessTree
    Username

    string

    ECS インスタンスでコマンドを実行するために使用されるユーザー名。

    test
    NextToken

    string

    この呼び出しで返されるページネーショントークン。

    AAAAAdDWBF2
    PageNumber

    integer

    現在のページ番号。

    1
    PageSize

    integer

    ページングクエリ用に設定された 1 ページあたりのエントリ数。

    1
    TotalCount

    integer

    コマンドの総数。

    1
    RequestId

    string

    リクエスト ID

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

    例

    成功レスポンス

    JSONJSON

    {
  "Invocation": {
    "InvocationResults": {
      "InvocationResult": [
        {
          "CommandId": "c-hz0jdfwcsr****",
          "ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
          "ContainerName": "test-container",
          "Dropped": 0,
          "ErrorCode": "InstanceNotExists",
          "ErrorInfo": "指定されたインスタンスが存在しません",
          "ExitCode": 0,
          "FinishedTime": "2019-12-20T06:15:56Z",
          "InstanceId": "i-bp1i7gg30r52z2em****",
          "InvocationStatus": "Success",
          "InvokeId": "t-hz0jdfwd9f****",
          "InvokeRecordStatus": "Running",
          "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
          "OssOutputDelivery": "oss://testBucket/testPrefix",
          "OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
          "OssOutputErrorInfo": "The invocation status does not support output delivery",
          "OssOutputStatus": "Finished",
          "OssOutputUri": "oss://testBucket/testPrefix/output.txt",
          "Output": "MTU6MzA6MDEK",
          "Repeats": 0,
          "StartTime": "2019-12-20T06:15:55Z",
          "StopTime": "2020-01-19T09:15:47Z",
          "Tags": {
            "Tag": [
              {
                "TagKey": "owner",
                "TagValue": "zhangsan"
              }
            ]
          },
          "TerminationMode": "ProcessTree",
          "Username": "test"
        }
      ]
    },
    "NextToken": "AAAAAdDWBF2",
    "PageNumber": 1,
    "PageSize": 1,
    "TotalCount": 1
  },
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RegionId.ApiNotSupported The api is not supported in this region. 指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
    400 NumberExceed.Tags The Tags parameter number is exceed. タグの数が最大値を超えています。この操作では最大 20 個のタグを指定できます。
    400 Duplicate.TagKey The Tag.N.Key contain duplicate key. タグに重複するキーが存在します。すべてのキーが一意であることを確認してください。
    400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定されたタグキーパラメーターは無効です。
    400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定されたタグ値パラメーターは無効です。
    400 MissingParameter.TagKey You must specify Tag.N.Key. タグキーを指定してください。
    400 InvalidParam.PageNumber The specified parameter is invalid.
    400 InvalidParam.PageSize The specified parameter is invalid.
    400 InvalidParameter.NextToken The specified parameter NextToken is not valid.
    400 InvalidParameter.MaxResults The specified parameter MaxResults is not valid. 指定された MaxResults パラメーターは無効です。
    500 InternalError.Dispatch An error occurred when you dispatched the request. リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
    500 ServiceUnavailable The request has failed due to a temporary failure of the server.
    500 InternalError The request processing has failed due to some unknown error.
    403 InvalidParameterCharacter The specified parameter %s contains illegal characters.
    403 Operation.Forbidden The operation is not permitted. 操作は許可されていません。
    404 InvalidRegionId.NotFound The RegionId provided does not exist in our records. 指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。
    404 InvalidCommandId.NotFound The specified commandId does not exist

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

    変更履歴

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