用于查詢云助手腳本的執行列表和狀態。
接口說明
- 當您執行命令后,不代表命令一定成功執行,并且一定有預期的命令效果。您需要通過接口返回值來查看實際執行結果,以實際輸出結果為準。
- 您可以查詢最近 2 周的執行信息,執行信息的保留上限為 10 萬條。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
InvokeId | string | 否 | 腳本進程執行 ID。 | t-hz0jdfwd9f**** |
CommandType | string | 否 | 腳本類型。取值范圍:
| RunPowerShellScript |
InvokeStatus | string | 否 | 腳本執行的總執行狀態??倛绦袪顟B取決于創建執行中的一臺或多臺云桌面的共同執行狀態。取值范圍:
默認值:Running。 | Finished |
DesktopId | string | 否 | 云桌面 ID。如果指定了云桌面,則查詢該桌面所有的腳本執行記錄。 | ecd-7w78ozhjcwa3u**** |
IncludeOutput | boolean | 否 | 是否在結果中返回腳本運行的輸出信息。取值范圍:
默認值:false。 | false |
ContentEncoding | string | 否 | 返回數據的編碼方式。取值范圍:
默認值:Base64。 | PlainText |
MaxResults | integer | 否 | 分頁查詢時每頁行數。
| 10 |
NextToken | string | 否 | 查詢憑證(Token),取值為上一次 API 調用返回的 NextToken 參數值。 | AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
EndUserId | string | 否 | 用戶 ID。 | test1 |
DesktopIds | array | 否 | 云桌面 ID 列表。DesktopId 即將棄用,請使用當前字段傳遞 DesktopId 列表信息。 | |
string | 否 | 云桌面 ID | ecd-84mztzatmipf2**** |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Invocations": [
{
"InvokeId": "t-hz0jdfwd9f****",
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"CommandType": "RunPowerShellScript",
"InvocationStatus": "Pending",
"CreationTime": "2020-12-19T09:15:46Z",
"EndUserId": "User1",
"InvokeDesktops": [
{
"InvocationStatus": "Success",
"Output": "OutPutTestmsg",
"CreationTime": "2020-12-20T06:15:54Z",
"UpdateTime": "2020-12-25T06:15:56Z",
"Repeats": 0,
"DesktopId": "ecd-7w78ozhjcwa3u****",
"Dropped": 0,
"StartTime": "2020-12-20T06:15:55Z",
"StopTime": "2020-12-25T09:15:47Z",
"FinishTime": "2020-12-20T06:15:56Z",
"ExitCode": 0,
"ErrorCode": "InstanceNotExists",
"ErrorInfo": "The specified instance does not exist.",
"DesktopName": "demo1234"
}
],
"InvokeDesktopCount": 0,
"InvokeDesktopSucceedCount": 0
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-13 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-05-18 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
2022-10-18 | OpenAPI 入參發生變更 | 查看變更詳情 |
2022-09-29 | OpenAPI 入參發生變更 | 查看變更詳情 |