クラウドアシスタントコマンドのパラメーターと内容を変更します。

説明

  • コマンドの実行中にコマンドを変更することができます。変更後、新しいコマンド内容は後続の呼び出しに適用されます。
  • コマンドタイプは変更できません。たとえば、Shell コマンド (RunShellScript) を Bat コマンド (RunBatScript) に変更することはできません。

リクエストパラメーター

名前必須かどうか説明
ActionStringはいこのインタフェースの名前。値:ModifyCommand
RegionIdStringはいリージョン ID。詳細については、 DescribeRegions を呼び出して最新のリージョンリストを取得してください。
CommandIdStringはいコマンド ID。DescribeCommands APIを呼び出して、使用可能なすべての CommandId を確認できます。
NameStringいいえコマンド名。すべての文字エンコーディングセットをサポートしています。
DescriptionStringいいえコマンドの説明。すべての文字エンコーディングセットをサポートしています。
WorkingDirStringいいえコマンドが実行されるパス。デフォルト値:
  • Linux インスタンスの場合、コマンドは /root ディレクトリで実行されます。
  • Windows インスタンスの場合、コマンドはクラウドアシスタントクライアントプロセスが配置されているディレクトリで実行されます (C:\ProgramData\aliyun\assist\$(version) など)。
TimeOutIntegerいいえ ECS インスタンス上のコマンドの呼び出しタイムアウト値。単位は秒です。何らかの理由でコマンドが実行されないと、呼び出しがタイムアウトすることがあります。タイムアウト後、クラウドアシスタントクライアントは、コマンド PID をキャンセルして、コマンドプロセスを強制的に停止します。パラメーター値は 60 以上でなければなりません。値が 60 より小さい場合、デフォルトでタイムアウト値は 60 秒になります 。

デフォルト値:3600

レスポンスパラメーター

すべてのパラメーターは、共通のレスポンスパラメーターです。詳細については、「共通パラメーター」をご参照ください。

リクエストパラメーター
  1. https://ecs.aliyuncs.com/?Action=ModifyCommand&RegionId=cn-hangzhou&CommandId=c-e996287206324975b5fbe1dxxxxxxxxx&NameId=Test&TimeOut=120<Common Request Parameters>
レスポンス例 (成功)

XML 形式

  1. <ModifyCommandResponse> <RequestId>540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx</RequestId></ModifyCommandResponse>
JSON 形式
  1. {     RequestId”:”540CFF28-407A-40B5-B6A5-73Bxxxxxxxxx”,}
レスポンス例 (エラー)

XML 形式

  1. <Error> <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <HostId>ecs.aliyuncs.com</HostId> <Code>InvalidInstance.NoClient</Code> <Message>The specified instances have no cloud assistant client installed.</Message></Error>
JSON 形式
  1. {     RequestId”: 540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx”,     HostId”: ecs.aliyuncs.com     Code”: InvalidInstance.NoClient     Message”: The specified instances have no cloud assistant client installed.”}

エラーコード

このインターフェイスに固有のエラーコードは次のとおりです。詳細については、「common parameters」をご参照ください 。

エラーコードエラーメッセージ HTTP ステータスコード意味
MissingParameter.CommandIdThe input parameter “CommandId” that is mandatory for processing this request is not supplied.400 CommandId の必須パラメーターを指定する必要があります。
MissingParameter.RegionIdThe input parameter “RegionId” that is mandatory for processing this request is not supplied.400 RegionId の 必須パラメーターを指定する必要があります。または、指定したリージョン (RegionId) のリソースを使用することはできません。
InvalidCmdId.NotFoundThe specified commandId does not exist.404指定された CommandId は存在しません。
InvalidRegionId.NotFoundThe RegionId provided does not exist in our items.404指定された RegionId は存在しません。
InternalError.DispatchAn internal error occurred when dispath the request.500内部エラー。後でもう一度お試しください。