すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeInvocationResults

    ドキュメントセンター

    Elastic Compute Service:DescribeInvocationResults

    最終更新日:Jun 26, 2026

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

    操作説明

    操作説明

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

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

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

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

    • DescribeInvocations と DescribeInvocationResults の違い:

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

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

        • DescribeInvocationResults は各インスタンスでの個別の実行ステータスのみを返し、インスタンス間の集約ステータスは返しません。

      • 1 回の 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。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

    t-hz0jdfwd9f****
    InstanceId

    string

    任意

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

    i-bp1i7gg30r52z2em****
    CommandId

    string

    任意

    インスタンス ID

    c-hz0jdfwcsr****
    InvokeRecordStatus

    string

    任意

    コマンド ID。

    Running
    IncludeHistory

    boolean

    任意

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

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

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

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

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

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

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

    • Success:

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

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

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

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

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

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

      • スケジュール実行: コマンドプロセスのステータスが部分的に失敗になることはありません。

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

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

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

    false
    ContentEncoding

    string

    任意

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

    • true: スケジュールコマンドの実行結果を返します。このパラメーターを true に設定する場合、InvokeId パラメーターは必須であり、スケジュールコマンド（RepeatMode が Period）またはシステム起動時に毎回実行されるコマンド（RepeatMode が EveryReboot）の実行 ID である必要があります。

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

    デフォルト値: false。

    PlainText
    PageNumber

    integer

    任意

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

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

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

    デフォルト値: Base64。

    1
    PageSize

    integer

    任意

    説明

    このパラメーターはオフラインになる予定です。NextToken と MaxResults を使用してページングクエリ操作を完了してください。

    1
    MaxResults

    integer

    任意

    説明

    このパラメーターはオフラインになる予定です。NextToken と MaxResults を使用してページングクエリ操作を完了してください。

    10
    NextToken

    string

    任意

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

    最大値: 50。

    デフォルト値: 10。

    AAAAAdDWBF2
    Tag

    array<object>

    任意

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

    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 ページあたりのエントリ数。この値はページングクエリ設定で指定された PageSize 値です。

    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

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

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

    • 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
    StartTime

    string

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

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

    integer

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

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

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

    0
    InvokeRecordStatus

    string

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

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

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

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

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

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

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

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

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

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

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

      • スケジュール実行: コマンドプロセスのステータスが部分的に失敗になることはありません。

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

    • 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

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

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

    • 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.
    400 NumberExceed.Tags The Tags parameter number is exceed.
    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.
    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.

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

    変更履歴

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