修改云助手定時任務的執(zhí)行信息,包括命令內容、定時執(zhí)行方式、添加ECS實例或托管實例到任務。
接口說明
- 支持修改以下執(zhí)行方式的任務(參見 DescribeInvocations 返回的
RepeatMode
值):- Period:周期執(zhí)行。
- NextRebootOnly:當實例下一次啟動時,自動執(zhí)行命令。
- EveryReboot:實例每一次啟動都將自動執(zhí)行命令。
- 支持修改以下狀態(tài)的任務(參見 DescribeInvocations 返回的
InvocationStatus
值):- Pending:系統(tǒng)正在校驗或發(fā)送命令。存在至少一臺實例的命令執(zhí)行狀態(tài)為 Pending,則總執(zhí)行狀態(tài)為 Pending。
- Running:命令正在實例上運行。存在至少一臺實例的命令執(zhí)行狀態(tài)為 Running,則總執(zhí)行狀態(tài)為 Running。
- Scheduled:定時執(zhí)行的命令已發(fā)送,等待運行。存在至少一臺實例的命令執(zhí)行狀態(tài)為 Scheduled,則總執(zhí)行狀態(tài)為 Scheduled。
- Stopping:正在停止任務。存在至少一臺實例的命令執(zhí)行狀態(tài)為 Stopping,則總執(zhí)行狀態(tài)為 Stopping。
- 修改定時任務執(zhí)行信息(包括命令內容、自定義參數、執(zhí)行頻率)前,已執(zhí)行的 ECS 實例或托管實例的云助手 Agent 版本需要高于以下對應的版本。
- Linux:2.2.3.541
- Windows:2.1.3.541
- 如果調用結果返回
InvalidOperation.CloudAssistantVersionUnsupported
錯誤碼,請將云助手 Agent 更新至最新版本。
- 當您執(zhí)行一個云助手公共命令時,無法修改命令內容
CommandContent
。 - 當您修改了命令內容
CommandContent
,且調用 InvokeCommand 或調用 RunCommand 時設置KeepCommand
為true
創(chuàng)建任務,將會新增一條命令并長期保留,并占用云助手命令配額;在一個地域下,您最多可以保有 500~50,000 條云助手命令。您也可以申請?zhí)嵘漕~,關于如何查詢及提升配額,請參見配額管理。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
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 或托管實例 ID。 | |
string | 否 | 待加入任務的 ECS 實例 ID 或托管實例 ID。待加入的實例數量與已執(zhí)行的實例數量總和不得超過 100。 | i-bp1i7gg30r52z2em**** | |
InvokeId | string | 是 | 待修改任務的命令執(zhí)行 ID。 | t-hz0jdfwd9f**** |
CommandContent | string | 否 | 待修改后的命令內容。命令內容可以是明文內容或 Base64 編碼后的內容。您需要注意:
| ZWNobyAxMjM= |
EnableParameter | boolean | 否 | 修改命令中是否包含自定義參數。
| false |
Parameters | object | 否 | 命令中包含自定義參數時,修改執(zhí)行命令時傳入的自定義參數的鍵值對。 自定義參數的個數范圍為 0~10,且您需要注意:
默認值為空,表示不涉及自定義參數鍵值對的修改。 | {"name":"Jack", "accessKey":"LTAIdyvdIqaRY****"} |
Frequency | string | 否 | 待修改的定時執(zhí)行頻率。僅當
| 0 */20 * * * * |
ContentEncoding | string | 否 | 命令內容(
默認值:PlainText,填寫錯誤時會當作 PlainText 處理。 | PlainText |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"CommandId": "c-hz01272yr52****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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中的鍵與創(chuàng)建命令時定義的不匹配。 |
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解碼。 |
403 | InvalidInstanceId.OSTypeUnsupported | The OS type of the instance corresponding to the parameter InstanceId does not support the specified command type. | 參數InstanceId對應實例的操作系統(tǒng)類型不支持指定的命令類型。 |
403 | InvalidOperation.RepeatModeUnsupported | The operation is not supported for current repeat mode of invocation. | 當前命令執(zhí)行的方式不支持該操作。 |
403 | InvalidOperation.InvokeAlreadyFinished | The operation is not supported for finished invocation. | 已執(zhí)行完成的任務不支持該操作。 |
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 | 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中值的類型。 |
404 | InvalidInvokeId.NotFound | The specified parameter InvokeId does not exist. | 指定的命令執(zhí)行ID不存在。 |
404 | InvalidInstanceId.NotFound | The specified parameter InstanceId does not exist. | 指定的實例ID不存在。 |
404 | InvalidRegionId.NotFound | The specified parameter RegionId does not exist. | 指定的地域ID不存在。 |
500 | InternalError | An error occurred when you dispatched the request. | 發(fā)送請求時發(fā)生錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-05 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-04-03 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |