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

Elastic Compute Service:ModifyInvocationAttribute

最終更新日:Apr 04, 2026

クラウドアシスタントの定期コマンドタスクの実行情報を変更します。これには、コマンドの内容や実行頻度の変更、Elastic Compute Service (ECS) インスタンスや Alibaba Cloud マネージドインスタンスのコマンドタスクへの追加が含まれます。

操作説明

  • 次の実行モード (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 を変更し、InvokeCommand または RunCommand を呼び出す際に KeepCommandtrue に設定してタスクを作成すると、新しいコマンドが作成されて永続的に保持され、クラウドアシスタントのコマンドクォータを消費します。各リージョンでは、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。ECS インスタンスまたはマネージドインスタンスを追加した後、定期コマンドタスク内のインスタンスの総数は 100 を超えることはできません。

i-bp1i7gg30r52z2em****

RegionId

string

必須

リージョン ID。

cn-hangzhou

InvokeId

string

必須

コマンドの実行 ID。

t-hz0jdfwd9f****

CommandContent

string

任意

変更後のコマンドの内容。コマンドの内容は、プレーンテキストまたは Base64 エンコード形式にすることができます。次の点にご注意ください:

  • コマンド作成時に、コマンド実行後にコマンドを保持するかどうかを指定できます。コマンドを保持するように指定した場合、Base64 エンコードされたコマンドの内容は 18 KB を超えることはできません。コマンドを保持しないように指定した場合、Base64 エンコードされたコマンドの内容は 24 KB を超えることはできません。

  • コマンドの内容が Base64 エンコードされている場合は、ContentEncoding を Base64 に設定します。

  • EnableParameter を true に設定すると、カスタムパラメーター機能が有効になり、次のルールに基づいてカスタムパラメーターを設定できます:

    • カスタムパラメーターは {{}} 形式で定義できます。{{}} 内では、パラメーター名の前後のスペースと改行は無視されます。

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

    • カスタムパラメーター名には、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。名前は大文字と小文字を区別しません。ACS:: プレフィックスを使用して、組み込みでない環境パラメーターを指定することはできません。

    • 各カスタムパラメーター名の長さは 64 バイトを超えることはできません。

  • 組み込み環境変数をカスタムパラメーターとして指定できます。その後、コマンドを実行すると、これらのパラメーターはクラウドアシスタントによって自動的に指定されます。次の組み込み環境変数を指定できます:

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

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

    • {{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 を設定してコマンド内のカスタムパラメーターを変更する場合は、EnableParameter を true に設定します。

  • Parameters を設定してコマンド内のカスタムパラメーターを変更しない場合は、EnableParameter を空のままにするか、false に設定します。

false

Parameters

object

任意

コマンドにカスタムパラメーターが含まれている場合に渡される、カスタムパラメーターのキーと値のペア。

0 から 10 個のカスタムパラメーターを指定できます。次の点にご注意ください:

  • カスタムパラメーターのキーは最大 64 文字で、空の文字列にすることはできません。

  • カスタムパラメーターの値は空の文字列にすることができます。

  • コマンドタスクの作成時にコマンドを保持するように指定した場合、Base64 でエンコードされたカスタムパラメーターと元のコマンドコンテンツの合計サイズは 18 KB を超えることはできません。コマンドタスクの作成時にコマンドを保持しないように指定した場合、Base64 でエンコードされたカスタムパラメーターと元のコマンドコンテンツの合計サイズは 24 KB を超えることはできません。

  • Parameters で指定されたカスタムパラメーター名は、コマンド作成時に指定したカスタムパラメーター名に含まれている必要があります。渡されないパラメーターを表すために空の文字列を使用できます。

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

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

Frequency

string

任意

コマンドを実行する頻度。このパラメーターは、RepeatModePeriod に設定されている場合にのみ有効です。レート式に基づいて固定間隔でコマンドを実行したり、特定の時点で一度だけ実行したり、cron 式に基づいて指定された時点で実行したりするように設定できます。

  • 固定間隔でコマンドを実行するには、レート式を使用して間隔を指定します。間隔は秒、分、時間、または日で指定できます。このオプションは、固定間隔でタスクを実行する必要があるシナリオに適しています。間隔は次の形式で指定します:rate(<実行間隔の値> <実行間隔の単位>)。たとえば、5 分ごとにコマンドを実行するには rate(5m) を指定します。間隔を指定する際は、次の制限に注意してください:

    • 指定する間隔は 60 秒から 7 日の範囲内である必要があり、定期タスク作成時に指定したタイムアウト期間よりも長くする必要があります。

    • 間隔は、2 つの連続した実行の間に経過する時間です。間隔は、コマンドを 1 回実行するのに必要な時間とは無関係です。たとえば、間隔を 5 分に設定し、コマンドの実行に 2 分かかる場合、コマンドの実行が完了するたびに、システムは 5 分ではなく 3 分待ってからコマンドを再度実行します。

    • 次回コマンドが実行される時点は、タスクの作成時刻 (DescribeInvocations 操作によって返される CreationTime の値) と変更された実行間隔に基づいて計算されます。

  • 特定の時間に一度だけコマンドを実行するには、時点とタイムゾーンを指定します。時点は at(yyyy-MM-dd HH:mm:ss <タイムゾーン>) 形式で指定します。これは at(年-月-日 時:分:秒 <タイムゾーン>) を意味します。タイムゾーンを指定しない場合、デフォルトで協定世界時 (UTC) タイムゾーンが使用されます。タイムゾーンは次の形式で指定できます:

    • タイムゾーン名。例:Asia/Shanghai および America/Los_Angeles

    • GMT からの時刻オフセット。例:GMT+8:00 (UTC+8) および GMT-7:00 (UTC-7)。GMT 形式を使用する場合、時間の値に先行ゼロを追加することはできません。

    • タイムゾーンの略語。UTC のみサポートされています。

    たとえば、2022 年 6 月 6 日 13:15:30 (上海時間) に一度だけコマンドを実行するように設定するには、時刻を at(2022-06-06 13:15:30 Asia/Shanghai) に設定します。2022 年 6 月 6 日 13:15:30 (UTC-7) に一度だけコマンドを実行するように設定するには、時刻を at(2022-06-06 13:15:30 GMT-7:00) に設定します。

  • 指定された時点でコマンドを実行するには、cron 式を使用してスケジュールを定義します。スケジュールは <Cron 式> <タイムゾーン> 形式で指定します。cron 式は <秒> <分> <時> <日> <月> <曜日> <年 (オプション)> 形式です。システムは、指定された cron 式とタイムゾーンに基づいてコマンドの実行時間を計算し、スケジュールどおりにコマンドを実行します。タイムゾーンを指定しない場合、デフォルトでコマンドを実行するインスタンスのシステムタイムゾーンが使用されます。cron 式の詳細については、「Cron 式」をご参照ください。タイムゾーンは次の形式で指定できます:

    • タイムゾーン名。例:Asia/Shanghai および America/Los_Angeles

    • GMT からの時刻オフセット。例:GMT+8:00 (UTC+8) および GMT-7:00 (UTC-7)。GMT 形式を使用する場合、時間の値に先行ゼロを追加することはできません。

    • タイムゾーンの略語。UTC のみサポートされています。たとえば、2022 年に毎日 10:15:00 (上海時間) にコマンドを実行するように設定するには、スケジュールを 0 15 10 ? * * 2022 Asia/Shanghai に設定します。2022 年に毎日 10:00:00 から 11:30:00 まで 30 分ごとにコマンドを実行するように設定するには (UTC+8)、スケジュールを 0 0/30 10-11 * * ? 2022 GMT+8:00 に設定します。2022 年から 2 年ごとに 10 月に毎日 14:00:00 から 14:55:00 まで 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。

  • CommandContent が変更された場合にのみ、新しいコマンドが追加され、新しいコマンドの CommandId 値が返されます。

  • CommandContent が変更されない場合、新しいコマンドは追加されず、実行中のコマンドの CommandId 値が返されます。

  • InvokeCommand または RunCommand 操作を呼び出す際に KeepCommandtrue に設定した場合、新しいコマンドが追加されて保持されます。そうでない場合、タスクのすべての実行が完了した後、またはタスクが手動で停止された後、タスクに関連するコマンドは削除されます。

c-hz01272yr52****

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.Frequency The specified parameter Frequency is not valid.
400 InvalidParameters.KeyDuplicate The key in the parameter Parameters cannot be duplicated.
400 InvalidParameters.KeyNotMatch The key in the parameter Parameters do not match those defined when creating the command.
400 InvalidParameters.KeyMalformed The key in the parameter Parameters is not valid.
400 InvalidParameters.KeyEmpty The key in the parameter Parameters cannot be empty.
400 InvalidCommandContent.DecodeError The specified parameter CommandContent can not be Base64 decoded.
400 InvalidClientToken.Malformed The specified parameter clientToken is not valid.
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.
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.
403 InvalidParameters.CountLimitExceeded The count of the parameter Parameters exceeds the limit of 10.
403 InvalidParameters.KeyLengthLimitExceeded The length of the key in the parameter Parameters exceeds the limit of 64 characters.
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.
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.
404 InvalidInstanceId.NotFound The specified parameter InstanceId does not exist.
404 InvalidRegionId.NotFound The specified parameter RegionId does not exist.
404 InvalidCommandId.NotFound The specified CommandId does not exist.

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

変更履歴

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