すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeInvocations

    ドキュメントセンター

    Elastic Compute Service:DescribeInvocations

    最終更新日:Aug 28, 2026

    クラウドアシスタントコマンドの実行リストおよびステータスを照会します。

    操作説明

    • コマンドを実行した後、必ずしも正常に実行されるわけではなく、期待どおりの結果が得られるとは限りません。この操作の戻り値をビューで確認して、実際の実行結果をチェックする必要があります。実際の出力が優先されます。

    • 過去 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 は最新のタスクステータスのみを返します。

      • コマンドの内容とパラメーターをビューで確認する必要がある場合、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:DescribeInvocations

    get

    Instance。

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

    Command。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

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

    cn-hangzhou
    ResourceGroupId

    string

    任意

    コマンド実行が属するリソースグループの ID。このパラメーターを指定すると、コマンド実行時に指定された ResourceGroupId に基づいてコマンド実行結果がフィルター処理されます。

    rg-bp67acfmxazb4p****
    InvokeId

    string

    任意

    コマンド実行 ID。

    t-hz0jdfwd9f****
    CommandId

    string

    任意

    コマンド ID。 DescribeCommands を呼び出して、利用可能なすべてのコマンド ID をクエリできます。

    c-hz0jdfwcsr****
    CommandName

    string

    任意

    コマンド名。InstanceId も指定した場合、このパラメーターは効果がありません。

    CommandTestName
    CommandType

    string

    任意

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

    • RunBatScript: Windows インスタンスで実行される Bat スクリプト。

    • RunPowerShellScript: Windows インスタンスで実行される PowerShell スクリプト。

    • RunShellScript: Linux インスタンスで実行される Shell スクリプト。

    RunShellScript
    Timed

    boolean

    任意

    コマンドが将来自動的に実行するかどうかを指定します。有効な値:

    • true: RunCommand または InvokeCommand の呼び出し時に RepeatMode パラメーターが Period、NextRebootOnly、または EveryReboot にセットされたコマンドをクエリします。

    • false: 次の 2 つの状態のコマンドをクエリします。

      • RunCommand または InvokeCommand の呼び出し時に RepeatMode パラメーターが Once にセットされたコマンド。

      • キャンセル、停止、または完了したコマンド。

    デフォルト値: false。

    true
    InvokeStatus

    string

    任意

    コマンドの全体的な実行ステータス。全体的な実行ステータスは、実行対象の 1 つ以上のインスタンスにおける共通の実行ステータスに依存します。有効な値:

    • Running:

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

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

    • Finished:

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

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

    • Success: 各インスタンスでのコマンド実行ステータスが Stopped または Success であり、少なくとも 1 つのインスタンスでコマンド実行ステータスが Success です。

      • 即時実行タスク: コマンド実行が完了し、終了コードが 0 です。

      • 定期タスク: 最後の実行が成功し終了コードが 0 で、指定されたすべての実行時間が経過しています。

    • Failed:

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

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

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

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

    • PartialFailed: 一部のインスタンスではコマンドが成功しましたが、他のインスタンスでは失敗しました。InstanceId も指定した場合、この値は効果がありません。

    • Pending: システムがコマンドを検証または送信しています。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Pending の場合、全体的な実行ステータスは Pending です。

    • Scheduled: スケジュールされたコマンドが送信され、実行待ちです。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Scheduled の場合、全体的な実行ステータスは Scheduled です。

    Finished
    InstanceId

    string

    任意

    インスタンス ID。このパラメーターを指定すると、そのインスタンスのすべてのコマンド実行レコードが照会されます。

    i-bp1i7gg30r52z2em****
    ContentEncoding

    string

    任意

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

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

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

    デフォルト値: Base64。

    PlainText
    IncludeOutput

    boolean

    任意

    結果にコマンド出力を含めるかどうかを指定します。

    • true: コマンド出力が返されます。少なくとも InvokeId または InstanceId を指定する必要があります。

    • false: コマンド出力は返されません。

    デフォルト値: false。

    false
    PageNumber

    integer

    任意

    説明

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

    1
    PageSize

    integer

    任意

    説明

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

    10
    MaxResults

    integer

    任意

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

    最大値: 50。

    デフォルト値: 10。

    10
    NextToken

    string

    任意

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

    AAAAAdDWBF2
    RepeatMode

    string

    任意

    コマンドの実行モード。InstanceId も指定した場合、このパラメーターは効果がありません。有効な値:

    • Once: コマンドが即時実行されます。

    • Period: コマンドがスケジュールに従って実行されます。

    • NextRebootOnly: インスタンスの次回起動時にコマンドが自動実行されます。

    • EveryReboot: インスタンスの起動時に毎回コマンドが自動実行されます。

    デフォルト値: 空。すべての実行モードがクエリされることを示します。

    Once
    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

    PageSize

    integer

    ページサイズ。

    10
    RequestId

    string

    リクエスト ID

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

    integer

    クエリ結果のページ番号。

    1
    TotalCount

    integer

    コマンドの総数。

    1
    NextToken

    string

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

    AAAAAdDWBF2
    Invocations

    object

    Invocation

    array<object>

    コマンド実行レコード。

    array<object>

    タスクが作成された時間。

    OssOutputDelivery

    string

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

    oss://testBucket/testPrefix
    InvocationStatus

    string

    コマンドの全体的な実行ステータス。全体的な実行ステータスは、この呼び出しにおけるすべてのインスタンスの共通の実行ステータスに依存します。有効な値:

    • Pending: システムがコマンドを検証または送信しています。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Pending の場合、全体的な実行ステータスは Pending です。

    • Scheduled: スケジュールされたコマンドが送信され、実行待ちです。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Scheduled の場合、全体的な実行ステータスは Scheduled です。

    • Running: インスタンス上でコマンドが実行されています。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Running の場合、全体的な実行ステータスは Running です。

    • Success: 各インスタンスでのコマンド実行ステータスが Stopped または Success であり、少なくとも 1 つのインスタンスでコマンド実行ステータスが Success です。

      • 即時実行タスク: コマンド実行が完了し、終了コードが 0 です。

      • 定期タスク: 最後の実行が成功し終了コードが 0 で、指定されたすべての実行時間が経過しています。

    • Failed: 各インスタンスでのコマンド実行ステータスが Stopped または Failed です。1 つ以上のインスタンスでのコマンド実行ステータスが以下のいずれかである場合、全体的な実行ステータスは Failed です。

      • コマンド検証失敗 (Invalid)。

      • コマンド配信失敗 (Aborted)。

      • コマンド実行完了、ただし終了コードが 0 以外 (Failed)。

      • コマンド実行タイムアウト (Timeout)。

      • コマンド実行中に例外発生 (Error)。

    • Stopping: タスクが停止中です。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Stopping の場合、全体的な実行ステータスは Stopping です。

    • Stopped: タスクが停止されました。すべてのインスタンスでのコマンド実行ステータスが Stopped の場合、全体的な実行ステータスは Stopped です。インスタンスレベルのステータスが以下のいずれかである場合、ステータスは Stopped です。

      • タスクがキャンセルされた (Cancelled)。

      • タスクが強制終了された (Terminated)。

    • PartialFailed: 一部のインスタンスではコマンドが成功しましたが、他のインスタンスでは失敗しました。各インスタンスでのコマンド実行ステータスが Success、Failed、または Stopped の場合、全体的な実行ステータスは PartialFailed です。

    説明

    InvokeStatus レスポンスパラメーターも同様の意味を持ちますが、代わりにこのパラメーターを確認することを推奨します。

    Running
    Parameters

    string

    コマンド内のカスタムパラメーター。

    {}
    Timed

    boolean

    コマンドが将来自動的に実行するかどうかを示します。

    false
    CommandDescription

    string

    コマンドの説明。

    テストスクリプト
    Timeout

    integer

    ECS インスタンス上でのコマンド実行の最大タイムアウト期間。単位: 秒。

    何らかの理由でコマンドを実行できない場合、タイムアウトが発生します。タイムアウトが発生すると、コマンドの PID をキャンセルすることでコマンドプロセスが強制的に終了されます。

    60
    InvokeInstances

    object

    InvokeInstance

    array<object>

    ターゲットインスタンスセットタイプ。

    object

    実行ステータスリスト。

    Dropped

    integer

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

    0
    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****
    Timed

    boolean

    コマンドが将来自動的に実行するかどうかを示します。

    false
    InstanceInvokeStatus

    string

    単一インスタンスでのコマンド実行ステータス。

    説明

    このパラメーターではなく、InvocationStatus パラメーターを確認することを推奨します。

    Finished
    ExitCode

    integer

    コマンドプロセスの終了コード。有効な値:

    • Linux インスタンスの場合、Shell プロセスの終了コード。

    • 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: ファイル配信中にインスタンスがリリースされました。

    指定されたインスタンスが存在しません
    StartTime

    string

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

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

    integer

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

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

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

    0
    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.
    FinishTime

    string

    コマンドプロセスの終了時間。

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

    string

    コマンド出力。

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

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

    OutPutTestmsg
    CreationTime

    string

    コマンド実行の開始時刻。

    2019-12-20T06:15:54Z
    UpdateTime

    string

    コマンドステータスが更新された時間。

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

    string

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

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

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

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

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

    • CommandNotApplicable: 指定されたコマンドは指定されたインスタンスに該当なしです。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    InstanceNotExists
    StopTime

    string

    コマンド実行を停止するために StopInvocation が呼び出された時間。

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

    string

    コマンドの内容。

    • ContentEncoding が PlainText に設定されている場合、元のスクリプト内容が返されます。

    • ContentEncoding が Base64 に設定されている場合、Base64 エンコードされたスクリプト内容が返されます。

    cnBtIC1xYSB8IGdyZXAgdnNm****
    WorkingDir

    string

    コマンド実行の作業ディレクトリ。

    /home/
    RepeatMode

    string

    コマンドの実行モード。有効な値:

    • Once: コマンドが即時実行されます。

    • Period: コマンドがスケジュールに従って実行されます。

    • NextRebootOnly: インスタンスの次回起動時にコマンドが自動実行されます。

    • EveryReboot: インスタンスの起動時に毎回コマンドが自動実行されます。

    • DryRun: リクエストのドライランのみが実行されます。コマンドは実際には実行されません。システムはリクエストパラメーター、インスタンス実行環境、およびクラウドアシスタントエージェントのステータスをチェックします。

    Once
    InvokeStatus

    string

    コマンドの全体的な実行ステータス。

    説明

    このパラメーターではなく、InvocationStatus パラメーターを確認することを推奨します。

    Finished
    CommandType

    string

    コマンドタイプ。

    RunShellScript
    Username

    string

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

    test
    ContainerId

    string

    コンテナ ID。

    ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
    ContainerName

    string

    コンテナ名。

    テストコンテナ
    CreationTime

    string

    タスクが作成された時間。

    2020-01-19T09:15:46Z
    Frequency

    string

    スケジュールされたコマンド実行のスケジュール。

    0 */20 * * * *
    Launcher

    string

    スクリプト実行のランチャー。ランチャーの長さは 1 KB を超えることはできません。

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

    string

    コマンド ID。

    c-hz0jdfwcsr****
    CommandName

    string

    コマンド名。

    CommandTestName
    InvokeId

    string

    コマンド実行 ID。

    t-hz0jdfwd9f****
    TerminationMode

    string

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

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

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

    ProcessTree
    Tags

    object

    Tag

    array<object>

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

    object

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

    TagKey

    string

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

    owner
    TagValue

    string

    コマンド実行のタグ値。

    zhangsan

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "Invocations": {
    "Invocation": [
      {
        "OssOutputDelivery": "oss://testBucket/testPrefix",
        "InvocationStatus": "Running",
        "Parameters": "{}",
        "Timed": false,
        "CommandDescription": "testDescription",
        "Timeout": 60,
        "InvokeInstances": {
          "InvokeInstance": [
            {
              "Dropped": 0,
              "InvocationStatus": "Success",
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "Timed": false,
              "InstanceInvokeStatus": "Finished",
              "ExitCode": 0,
              "ErrorInfo": "the specified instance does not exists",
              "StartTime": "2019-12-20T06:15:55Z",
              "Repeats": 0,
              "OssOutputUri": "oss://testBucket/testPrefix/output.txt",
              "OssOutputStatus": "Finished",
              "OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
              "OssOutputErrorInfo": "The invocation status does not support output delivery.",
              "FinishTime": "2019-12-20T06:15:56Z",
              "Output": "OutPutTestmsg",
              "CreationTime": "2019-12-20T06:15:54Z",
              "UpdateTime": "2020-01-19T09:15:47Z",
              "ErrorCode": "InstanceNotExists",
              "StopTime": "2020-01-19T09:15:47Z"
            }
          ]
        },
        "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
        "WorkingDir": "/home/",
        "RepeatMode": "Once",
        "InvokeStatus": "Finished",
        "CommandType": "RunShellScript",
        "Username": "test",
        "ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
        "ContainerName": "test-container",
        "CreationTime": "2020-01-19T09:15:46Z",
        "Frequency": "0 */20 * * * *",
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
        "CommandId": "c-hz0jdfwcsr****",
        "CommandName": "CommandTestName",
        "InvokeId": "t-hz0jdfwd9f****",
        "TerminationMode": "ProcessTree",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    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. リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
    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

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

    変更履歴

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