すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeInvocationResults

    ドキュメントセンター

    Elastic Compute Service:DescribeInvocationResults

    最終更新日:Aug 28, 2026

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

    操作説明

    操作の説明

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

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

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

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

    • DescribeInvocations と DescribeInvocationResults の違い:

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

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

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

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

        • DescribeInvocations と DescribeInvocationResults はほぼ互換性があります。どちらかをもう一方に置き換えることができます。

      • スケジュールされた (定期的な) タスクまたはシステム起動時に毎回実行するタスク (RepeatMode=Period, EveryReboot) の実行詳細を確認する必要がある場合、過去の実行回数の履歴を返せるのは DescribeInvocationResults のみです (IncludeHistory=true を指定する必要があります)。DescribeInvocations は最新のタスクステータスのみを返します。

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

    今すぐお試しください

    この 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。このパラメーターを指定した場合、コマンドを実行中にも ResourceGroupId を指定する必要があります。このパラメーターは、対応するコマンド実行結果をフィルター処理します。

    rg-bp67acfmxazb4p****
    InvokeId

    string

    任意

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

    t-hz0jdfwd9f****
    InstanceId

    string

    任意

    インスタンス ID

    i-bp1i7gg30r52z2em****
    CommandId

    string

    任意

    コマンド ID。

    c-hz0jdfwcsr****
    InvokeRecordStatus

    string

    任意

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

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

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

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

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

      • スケジュールされた実行: コマンドプロセスが finished ステータスになることはありません。

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

    • Success:

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

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

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

      • スケジュールされた実行: コマンドプロセスが failed ステータスになることはありません。

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

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

      • スケジュールされた実行: コマンドプロセスが partially failed ステータスになることはありません。

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

    • 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

    任意

    タグ。

    Value

    string

    任意

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

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

    TestValue
    Key

    string

    任意

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

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

    タグキーの長さは最大 64 文字で、aliyun または acs: で始まるものや、http:// または https:// を含むものは無効です。

    TestKey

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID

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

    object

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

    PageSize

    integer

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

    1
    PageNumber

    integer

    現在のページ番号。

    1
    TotalCount

    integer

    コマンドの総数。

    1
    NextToken

    string

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

    AAAAAdDWBF2
    InvocationResults

    object

    InvocationResult

    array<object>

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

    array<object>

    Dropped

    integer

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

    0
    OssOutputDelivery

    string

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

    oss://testBucket/testPrefix
    InvocationStatus

    string

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

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

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

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

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

    • Success:

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

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

    • Failed:

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

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

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

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

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

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

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

    • Scheduled:

      • 1 回限りの実行: 該当なし。この値は発生しません。

      • スケジュールされた実行: 実行待ちです。

    Success
    InstanceId

    string

    インスタンス ID

    i-bp1i7gg30r52z2em****
    ExitCode

    integer

    コマンドの終了コード。

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

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

    0
    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 to support the 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
    StartTime

    string

    インスタンス上でコマンドの実行が開始された時間。

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

    integer

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

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

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

    0
    InvokeRecordStatus

    string

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

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

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

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

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

      • スケジュールされた実行: コマンドプロセスが finished ステータスになることはありません。

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

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

      • スケジュールされた実行: コマンドプロセスが failed ステータスになることはありません。

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

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

      • スケジュールされた実行: コマンドプロセスが partially failed ステータスになることはありません。

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

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

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

    Running
    FinishedTime

    string

    コマンドの実行が完了した時間。コマンドの実行がタイムアウトした場合、完了時間は StartTime にコマンドのタイムアウト期間 Timeout を加算して計算されます。

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

    string

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

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

    string

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

    • InProgress: 配信中です。

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

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

    Finished
    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
    Username

    string

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

    test
    ContainerId

    string

    コンテナ ID。

    ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
    ContainerName

    string

    コンテナ名。

    test-container
    Output

    string

    コマンド実行の出力。

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

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

    MTU6MzA6MDEK
    Launcher

    string

    スクリプトを実行するために使用されたランチャー。長さは 1 KB を超えることはできません。

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

    string

    コマンド ID。

    c-hz0jdfwcsr****
    ErrorCode

    string

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

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

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

    • InstanceReleased: 同時実行中にインスタンスがリリースされました。

    • InstanceNotRunning: 同時実行中にインスタンスが実行中ではありませんでした。

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

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

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

    • BadCronExpression: 指定された cron 式が無効です。

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

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

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

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

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

    • ExecutionTimeout: 同時実行がタイムアウトしました。

    • ExecutionException: 同時実行中に例外が発生しました。

    • ExecutionInterrupted: 同時実行が中断されました。

    • ExitCodeNonzero: 同時実行が 0 以外の終了コードで完了しました。

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

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

    InstanceNotExists
    InvokeId

    string

    コマンド実行 ID。

    t-hz0jdfwd9f****
    TerminationMode

    string

    タスクを停止する際に使用されたモード (手動停止または実行タイムアウトによる中断)。有効な値:

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

    • ProcessTree: 現在のプロセストリー (スクリプトプロセスとそのプロセスによって作成されたすべての子プロセスのコレクション) を停止します。

    ProcessTree
    Tags

    object

    Tag

    array<object>

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

    object

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

    TagKey

    string

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

    owner
    TagValue

    string

    コマンド実行のタグ値。

    zhangsan
    StopTime

    string

    StopInvocation が呼び出されてコマンド実行が停止された時間。

    2020-01-19T09:15:47Z

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RegionId.ApiNotSupported The api is not supported in this region. 指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
    400 NumberExceed.Tags The Tags parameter number is exceed. タグの数が最大値を超えています。1 回の操作で最大 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 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

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

    変更履歴

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