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

Elastic Compute Service:ModifyInvocationAttribute

最終更新日:Aug 14, 2026

クラウドアシスタントの定期タスクの実行情報を変更します。変更対象には、コマンド内容、スケジュール実行メソッド、およびタスクへの ECS インスタンスまたはホストインスタンスの追加が含まれます。

操作説明

  • 以下の実行モードを持つタスクを変更できます( DescribeInvocations が返す RepeatMode の値を参照してください)。
    • Period: 定期的な実行。

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

    • EveryReboot: インスタンスの起動ごとにコマンドを自動実行します。

  • 以下のステータスのタスクを変更できます( DescribeInvocations が返す InvocationStatus の値を参照してください)。
    • Pending: システムがコマンドを検証または送信しています。少なくとも 1 つのインスタンスでのコマンド実行ステータスが Pending の場合、全体的な実行ステータスは Pending になります。

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

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

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

  • 定期タスクの実行情報(コマンド内容、カスタムパラメーター、実行周波数を含む)を変更する前に、すでにタスクを実行した ECS インスタンスまたはホストインスタンス上のクラウドアシスタントエージェントのバージョンが、以下のバージョンより新しいことを確認してください。
    • Linux: 2.2.3.541

    • Windows: 2.1.3.541

    • 呼び出し結果として InvalidOperation.CloudAssistantVersionUnsupported エラーコードが返された場合は、クラウドアシスタントエージェントを最新バージョンに更新してください。

  • クラウドアシスタントの共通コマンドを実行する場合、コマンド内容 CommandContent を変更することはできません。

  • コマンド内容 CommandContent を変更し、かつ KeepCommand を true に設定して InvokeCommand または RunCommand を呼び出してタスクが作成された場合、長期保持用の新しいコマンドが作成され、これがクラウドアシスタントコマンドクォータにカウントされます。リージョンあたり最大 500 ~ 50,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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:ModifyInvocationAttribute

update

*Invocation。

acs:ecs:{#regionId}:{#accountId}:invocation/{#invocationId}

Instance。

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

リージョン ID。

cn-hangzhou

InstanceId

array

任意

タスクに追加する ECS インスタンスまたはホストインスタンスのインスタンス ID。

string

任意

タスクに追加する ECS インスタンスまたはホストインスタンスのインスタンス ID。追加するインスタンス数とすでにタスクを実行するインスタンス数の合計は 100 を超えることはできません。

i-bp1i7gg30r52z2em****

InvokeId

string

必須

変更対象のタスクのコマンド実行 ID。

t-hz0jdfwd9f****

CommandContent

string

任意

変更済みのコマンド内容。コマンド内容はプレーンテキストまたは Base64 エンコーディングが可能です。以下の点にご注意ください。

  • Base64 エンコーディング後のコマンド内容のサイズは 24 KB 以下である必要があります。

  • コマンド内容が Base64 エンコーディングされている場合は、ContentEncoding=Base64 を設定する必要があります。

  • EnableParameter=true を指定することで、コマンド内容でカスタムパラメーター特徴を有効にできます。

    • カスタムパラメーターは {{}} で囲んで定義します。{{}} 内のパラメーター名の前後にあるスペースや改行は無視されます。

    • カスタムパラメーターの数は 20 個を超えることはできません。

    • カスタムパラメーター名には a-zA-Z0-9-_ の文字を使用できます。組み込み以外の環境パラメーターを指定するための acs:: プレフィックスはサポートされていません。その他の文字も使用できません。パラメーター名は大文字と小文字が区別されません。

    • 1 つのカスタムパラメーター名は 64 バイト以下である必要があります。

  • 組み込み環境パラメーターをカスタムパラメーターとして指定できます。コマンド実行時に手動で値を割り当てる必要はありません。クラウドアシスタントが自動的に環境内の対応する値に置き換えます。以下の組み込み環境パラメーターがサポートされています。

    • {{ACS::RegionId}}: リージョン ID。

    • {{ACS::AccountId}}: Alibaba Cloud アカウント ID。

    • {{ACS::InstanceId}}: インスタンス ID。コマンドが複数のインスタンスに送信される場合、{{ACS::InstanceId}} を組み込み環境パラメーターとして指定するには、クラウドアシスタントエージェントのバージョンが以下のバージョン以降であることを確認してください。
      • Linux: 2.2.3.309

      • Windows: 2.1.3.309

    • {{ACS::InstanceName}}: インスタンス名。コマンドが複数のインスタンスに送信される場合、{{ACS::InstanceName}} を組み込み環境パラメーターとして指定するには、クラウドアシスタントエージェントのバージョンが以下のバージョン以降であることを確認してください。
      • Linux: 2.2.3.344

      • Windows: 2.1.3.344

    • {{ACS::InvokeId}}: コマンド実行 ID。{{ACS::InvokeId}} を組み込み環境パラメーターとして指定するには、クラウドアシスタントエージェントのバージョンが以下のバージョン以降であることを確認してください。
      • Linux: 2.2.3.309

      • Windows: 2.1.3.309

    • {{ACS::CommandId}}: コマンド ID。この操作を呼び出してコマンドを実行する場合、{{ACS::CommandId}} を組み込み環境パラメーターとして指定するには、クラウドアシスタントエージェントのバージョンが以下のバージョン以降であることを確認してください。
      • Linux: 2.2.3.309

      • Windows: 2.1.3.309

ZWNobyAxMjM=

EnableParameter

boolean

任意

変更済みのコマンドにカスタムパラメーターが含まれるかどうかを指定します。

  • カスタムパラメーターを有効にする、またはカスタムパラメーター Parameters を変更する場合は、このパラメーターを true にセットします。

  • カスタムパラメーター Parameters を変更しない場合は、このパラメーターを設定しないか、false にセットします。

false

Parameters

object

任意

コマンドにカスタムパラメーターが含まれる場合に変更済みにするカスタムパラメーターのキーと値のペア。

カスタムパラメーターの数は 0 ~ 10 です。以下の点にご注意ください。

  • キーは空文字列にできず、最大 64 文字まで使用できます。

  • 値は空文字列でも構いません。

  • カスタムパラメーターと元のコマンド内容を Base64 エンコーディングした後、コマンド内容の合計サイズは 24 KB 以下である必要があります。

  • カスタムパラメーター名のセットは、コマンド作成時に定義されたパラメーターセットのサブセットである必要があります。渡されないパラメーターについては、空文字列を代用として使用できます。

デフォルト値: 空。カスタムパラメーターのキーと値のペアが変更済みでないことを示します。

{"name":"Jack", "accessKey":"LTAI*************"}

Frequency

string

任意

変更済みのスケジュール実行周波数。このパラメーターは RepeatMode が Period に設定されている場合にのみ効果があります。固定間隔実行(レート式に基づく)、指定時刻での 1 回限りの実行、時計ベースのスケジュール実行(Cron 式に基づく)の 3 種類のスケジュール実行がサポートされています。

  • 固定間隔実行: レート式に基づき、指定された時間間隔でコマンドが実行されます。時間間隔は秒 (s)、分 (m)、時 (h)、日 (d) で指定できます。これは、タスクを固定間隔で実行するシナリオに適用されます。形式: rate(<間隔値><間隔単位>)。たとえば、5 分ごとに実行する場合は rate(5m) を使用します。固定間隔実行には以下の制限があります。

    • 時間間隔は 7 日を超えることはできず、60 秒未満にすることはできません。また、定期タスク作成時に指定されたタイムアウト期間より長くする必要があります。

    • 実行間隔は固定周波数のみに基づいており、タスク実行に必要な実際の時間とは関係ありません。たとえば、コマンドが 5 分ごとに実行されるように設定されており、タスクの完了に 2 分かかる場合、次の四捨五入の実行はタスク完了の 3 分後に開始されます。

    • 次の実行時間は、タスクの作成時間(DescribeInvocations が返す CreationTime を参照。変更時間ではないことに注意してください)と変更済みの実行間隔に基づいて計算されます。

  • 指定時刻での 1 回限りの実行: 指定されたタイムゾーンおよび時刻ポイントにコマンドが 1 回実行されます。形式: at(yyyy-MM-dd HH:mm:ss <タイムゾーン>)、つまり at(年-月-日 時:分:秒 <タイムゾーン>) です。タイムゾーンが指定されていない場合、デフォルトは協定世界時 (UTC) です。タイムゾーンは以下の 3 つの形式をサポートしています。

    • フルタイムゾーン名: Asia/Shanghai(中国/上海時間)や America/Los_Angeles(米国/ロサンゼルス時間)など。

    • グリニッジ標準時からのタイムゾーンオフセット: GMT+8:00(東 8 番タイムゾーン)や GMT-7:00(西 7 番タイムゾーン)など。GMT 形式を使用する場合、時間の値に先行ゼロはサポートされていません。

    • タイムゾーン略語: UTC(協定世界時 (UTC))のみがサポートされています。

    たとえば、2022 年 6 月 6 日の 13:15:30 に中国/上海時間で 1 回実行するには、at(2022-06-06 13:15:30 Asia/Shanghai) を使用します。2022 年 6 月 6 日の 13:15:30 に西 7 番タイムゾーンで 1 回実行するには、at(2022-06-06 13:15:30 GMT-7:00) を使用します。

  • 時計ベースのスケジュール実行(Cron 式に基づく): Cron 式に基づき、定期タスクの設定に従ってコマンドが実行されます。形式: <秒> <分> <時> <日> <月> <曜日> <年(オプション)> <タイムゾーン>、つまり <Cron 式> <タイムゾーン> です。定期タスクの実行時間は、指定されたタイムゾーンの Cron 式に基づいて計算されます。タイムゾーンが指定されていない場合、デフォルトは定期タスクを実行するインスタンスの内部システムタイムゾーンです。Cron 式の詳細については、「Cron 式」をご参照ください。タイムゾーンは以下の 3 つの形式をサポートしています。

    • フルタイムゾーン名: Asia/Shanghai(中国/上海時間)や America/Los_Angeles(米国/ロサンゼルス時間)など。

    • グリニッジ標準時からのタイムゾーンオフセット: GMT+8:00(東 8 番タイムゾーン)や GMT-7:00(西 7 番タイムゾーン)など。GMT 形式を使用する場合、時間の値に先行ゼロはサポートされていません。

    • タイムゾーン略語: UTC(協定世界時 (UTC))のみがサポートされています。 たとえば、2022 年の毎日午前 10:15 に中国/上海時間で実行するには、0 15 10 ? * * 2022 Asia/Shanghai を使用します。2022 年の毎日午前 10:00 から午前 11:30 まで 30 分ごとに東 8 番タイムゾーンで実行するには、0 0/30 10-11 * * ? 2022 GMT+8:00 を使用します。2022 年から 2 年ごとの 10 月の毎日午後 2:00 から午後 2:55 まで 5 分ごとに協定世界時 (UTC) で実行するには、0 0/5 14 * 10 ? 2022/2 UTC を使用します。

    説明

    最小値の時間間隔は、定期タスク作成時に指定されたタイムアウト期間以上である必要があり、10 秒未満にすることはできません。

0 */20 * * * *

ContentEncoding

string

任意

コマンド内容 (CommandContent) のエンコーディング方式。有効な値(大文字と小文字は区別されません):

  • PlainText: エンコーディングなし。内容はプレーンテキストで送信されます。

  • Base64: Base64 エンコーディング。

デフォルト値: PlainText。無効な値が指定された場合、PlainText として扱われます。

PlainText

ClientToken

string

任意

リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken の値には ASCII 文字のみを使用でき、長さは 64 文字以下である必要があります。詳細については、「冪等性の確保方法」をご参照ください。

123e4567-e89b-12d3-a456-426655440000

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID

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

CommandId

string

コマンド ID。

  • 新しいコマンドが作成され、新しい CommandId が返されるのは、CommandContent が変更された場合のみです。

  • CommandContent が変更されていない場合、新しいコマンドは作成されず、現在実行中のコマンドの CommandId が返されます。

  • InvokeCommand を呼び出した場合、または KeepCommand を true に設定して RunCommand を呼び出した場合、新しいコマンドは保持されます。それ以外の場合、実行が完了するかタスクが手動で停止されると、タスクに関連付けられたすべてのコマンドが削除されます。

c-hz01272yr52****

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "CommandId": "c-hz01272yr52****"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.Frequency The specified parameter Frequency is not valid. 指定された Frequency パラメーターが無効です。
400 InvalidParameters.KeyDuplicate The key in the parameter Parameters cannot be duplicated. Parameters パラメーターのキーを重複させることはできません。
400 InvalidParameters.KeyNotMatch The key in the parameter Parameters do not match those defined when creating the command. Parameters パラメーターのキーが、コマンド作成時に定義されたキーと一致しません。
400 InvalidParameters.KeyMalformed The key in the parameter Parameters is not valid. Parameters パラメーターのキーが無効です。
400 InvalidParameters.KeyEmpty The key in the parameter Parameters cannot be empty. Parameters パラメーターのキーを空にすることはできません。
400 InvalidCommandContent.DecodeError The specified parameter CommandContent can not be Base64 decoded. CommandContent パラメーターを Base64 でデコードできません。
400 InvalidClientToken.Malformed The specified parameter clientToken is not valid. 指定された ClientToken パラメーターが形式要件を満たしていません。パラメーターには ASCII 文字のみを含める必要があり、長さは 64 文字を超えることはできません。
500 InternalError An error occurred when you dispatched the request. リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
403 InvalidInstanceId.OSTypeUnsupported The OS type of the instance corresponding to the parameter InstanceId does not support the specified command type. InstanceId で指定されたインスタンスのオペレーティングシステムタイプは、この操作をサポートしていません。
403 InvalidOperation.RepeatModeUnsupported The operation is not supported for current repeat mode of invocation. 現在のコマンド実行方式では、この操作はサポートされていません。
403 InvalidOperation.InvokeAlreadyFinished The operation is not supported for finished invocation. すでに完了したタスクでは、この操作はサポートされていません。
403 InvalidOperation.CloudAssistantVersionUnsupported The operation is not supported for current CloudAssistant version of instance. 現在のインスタンスのクラウドアシスタントバージョンでは、この操作はサポートされていません。
403 InvalidOperation.ModifyPublicCommandUnsupported Modification of the content of Public Command is not supported. パブリックコマンドの内容変更はサポートされていません。
403 InvalidCommandContent.LengthLimitExceeded The length of the parameter CommandContent exceeds the limit of %s KB characters.
403 Operation.Forbidden The operation is not permitted. 現在の RAM ユーザーには、この操作を実行する権限がありません。
403 InvalidParameters.CountLimitExceeded The count of the parameter Parameters exceeds the limit of 10. Parameters パラメーターのエントリ数が上限の 10 を超えています。
403 InvalidParameters.KeyLengthLimitExceeded The length of the key in the parameter Parameters exceeds the limit of 64 characters. Parameters パラメーターのキーの長さが上限の 64 文字を超えています。
403 InvalidInstanceId.CountLimitExceeded The count of the parameter InstanceId exceeds the limit of %s.
403 CommandLimitExceeded The count of command in current region exceeds the limit of %s.
403 InvalidParameters.ValueTypeUnsupported The type of the value in the parameter Parameters is not supported. Parameters パラメーターの値のタイプはサポートされていません。
403 IdempotentParameterMismatch The specified parameter has changed while using an already used clientToken. 指定されたクライアントトークンはすでに使用されています。
403 IdempotentProcessing The previous idempotent request(s) is still processing. 以前の冪等リクエストはまだ処理中です。後でもう一度お試しください。
404 InvalidInvokeId.NotFound The specified parameter InvokeId does not exist. 指定されたコマンド呼び出し ID が存在しません。
404 InvalidInstanceId.NotFound The specified parameter InstanceId does not exist. 指定されたインスタンス ID が無効です。
404 InvalidRegionId.NotFound The specified parameter RegionId does not exist. リージョン情報が無効です。
404 InvalidCommandId.NotFound The specified CommandId does not exist.

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

変更履歴

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