クラウドアシスタントの定期タスクの実行情報を変更します。変更対象には、コマンド内容、スケジュール実行メソッド、およびタスクへの 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 のクラウドアシスタントコマンドを保持できます。クォータの引き上げを申請することも可能です。クォータの確認および引き上げ方法については、「クォータ管理」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:ModifyInvocationAttribute |
update |
*Invocation。
Instance。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
| InstanceId |
array |
任意 |
タスクに追加する ECS インスタンスまたはホストインスタンスのインスタンス ID。 |
|
|
string |
任意 |
タスクに追加する ECS インスタンスまたはホストインスタンスのインスタンス ID。追加するインスタンス数とすでにタスクを実行するインスタンス数の合計は 100 を超えることはできません。 |
i-bp1i7gg30r52z2em**** |
|
| InvokeId |
string |
必須 |
変更対象のタスクのコマンド実行 ID。 |
t-hz0jdfwd9f**** |
| CommandContent |
string |
任意 |
変更済みのコマンド内容。コマンド内容はプレーンテキストまたは Base64 エンコーディングが可能です。以下の点にご注意ください。
|
ZWNobyAxMjM= |
| EnableParameter |
boolean |
任意 |
変更済みのコマンドにカスタムパラメーターが含まれるかどうかを指定します。
|
false |
| Parameters |
object |
任意 |
コマンドにカスタムパラメーターが含まれる場合に変更済みにするカスタムパラメーターのキーと値のペア。 カスタムパラメーターの数は 0 ~ 10 です。以下の点にご注意ください。
デフォルト値: 空。カスタムパラメーターのキーと値のペアが変更済みでないことを示します。 |
{"name":"Jack", "accessKey":"LTAI*************"} |
| Frequency |
string |
任意 |
変更済みのスケジュール実行周波数。このパラメーターは
|
0 */20 * * * * |
| ContentEncoding |
string |
任意 |
コマンド内容 (
デフォルト値: 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。
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。