調用DescribeInvocationResults查看一條或多條云助手命令的執行結果,即在ECS實例中的實際執行結果。
接口說明
-
當您執行命令后,不代表命令一定成功執行,并且一定有預期的命令效果。您需要通過本接口查看實際的具體執行結果,以實際輸出結果為準。
-
您可以查詢最近 4 周的執行信息,執行信息的保留上限為 10 萬條。
-
您可以通過云助手任務狀態事件訂閱的方式,通過事件獲取任務結果,避免頻繁輪詢,用以提升效率。
-
分頁查詢首頁時,僅需設置
MaxResults
以限制返回信息的條目數,返回結果中的NextToken
將作為查詢后續頁的憑證。查詢后續頁時,將NextToken
參數設置為上一次返回結果中獲取到的NextToken
作為查詢憑證,并設置MaxResults
限制返回條目數。 -
DescribeInvocations
和DescribeInvocationResults
差異點:- 當一次
RunCommand
/InvokeCommand
調用指定有多個實例時:- 使用
DescribeInvocations
可以獲得任務在各個實例上的執行狀態、多個實例任務狀態的聚合狀態; - 使用
DescribeInvocationResults
僅能獲得各個實例上的單獨的執行狀態,不包含多實例的聚合狀態;
- 使用
- 當一次
RunCommand
/InvokeCommand
調用指定有一個實例時:DescribeInvocations
與DescribeInvocationResults
區別不大,完全可以互相替換。
- 當需要查看定時性(周期性)任務、開機自動執行任務(
RepeatMode=Period, EveryReboot
)的每一次執行情況時,僅能用DescribeInvocationResults
可以查詢獲得執行的過往歷史記錄(需指定IncludeHistory=true
),而DescribeInvocations
僅支持返回最新的任務狀態。 - 當需要查看命令的內容、參數時,僅有
DescribeInvocations
返回CommandContent
。
- 當一次
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:DescribeInvocationResults | get | *Command acs:ecs:{#regionId}:{#accountId}:command/{#commandId} *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ResourceGroupId | string | 否 | 命令執行的資源組 ID。傳入該參數后,需要在執行命令時指定 ResourceGroupId,支持篩選出對應的命令執行結果。 | rg-bp67acfmxazb4p**** |
InvokeId | string | 否 | 命令執行 ID。您可以通過接口 DescribeInvocations 查詢 InvokeId。 | t-hz0jdfwd9f**** |
InstanceId | string | 否 | 實例 ID。 | i-bp1i7gg30r52z2em**** |
CommandId | string | 否 | 命令 ID。 | c-hz0jdfwcsr**** |
InvokeRecordStatus | string | 否 | 命令執行狀態。取值范圍:
| Running |
IncludeHistory | boolean | 否 | 是否返回命令定時執行的歷史記錄。取值范圍:
默認值為 false。 | false |
ContentEncoding | string | 否 | 設置返回數據中
默認值為 Base64。 | PlainText |
PageNumber | long | 否 | 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
PageSize | long | 否 | 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
MaxResults | integer | 否 | 分頁查詢時每頁的最大條目數。 最大值為 50。 默認值為 10。 | 10 |
NextToken | string | 否 | 查詢憑證(Token),取值為上一次 API 調用返回的 NextToken 參數值。 | AAAAAdDWBF2 |
Tag | array<object> | 否 | 標簽列表 | |
object | 否 | 標簽列表 | ||
Key | string | 否 | 命令執行的標簽鍵。N 的取值范圍為 1~20。一旦傳入該值,則不允許為空字符串。 使用一個標簽過濾資源,查詢到該標簽下的資源數量不能超過 1000 個;使用多個標簽過濾資源,查詢到同時綁定了多個標簽的資源數量不能超過 1000 個。如果資源數量超過 1000 個,您需要使用 ListTagResources 接口進行查詢。 最多支持 64 個字符,不能以 | TestKey |
Value | string | 否 | 命令執行的標簽值。N 的取值范圍為 1~20。該值可以為空字符串。 最多支持 128 個字符,不能包含 | TestValue |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
"Invocation": {
"PageSize": 1,
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"InvocationResults": {
"InvocationResult": [
{
"InvocationStatus": "Success",
"Repeats": 0,
"CommandId": "c-hz0jdfwcsr****",
"InstanceId": "i-bp1i7gg30r52z2em****",
"Output": "MTU6MzA6MDEK",
"Dropped": 0,
"StopTime": "2020-01-19T09:15:47Z",
"ExitCode": 0,
"StartTime": "2019-12-20T06:15:55Z",
"ErrorInfo": "the specified instance does not exists",
"ErrorCode": "InstanceNotExists",
"FinishedTime": "2019-12-20T06:15:56Z",
"InvokeId": "t-hz0jdfwd9f****",
"InvokeRecordStatus": "Running",
"Username": "test",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"TerminationMode": "ProcessTree",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持調用 API。請檢查 RegionId 參數取值是否正確。 |
400 | NumberExceed.Tags | The Tags parameter number is exceed. | 標簽個數超過最大限制。 |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標簽中存在重復的鍵,請保持鍵的唯一性。 |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標簽鍵參數有誤。 |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標簽值參數有誤。 |
400 | MissingParameter.TagKey | You must specify Tag.N.Key. | 請指定標簽鍵。 |
400 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的 PageNumber 參數無效。 |
400 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的 PageSize 參數無效。 |
400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的參數NextToken不合法。 |
400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的參數MaxResults不合法。 |
403 | Operation.Forbidden | The operation is not permitted. | 該操作是不被允許的。 |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 發送請求時發生錯誤,請稍后重試。 |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 請求后端超時,請稍后重試。 |
500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-08-01 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-05-14 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-12-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-05-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-02-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |