GetSessionScreenshots - Amazon DCV Session Manager

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

GetSessionScreenshots

取得一或多個 Amazon DCV 工作階段的螢幕擷取畫面。

若要修改映像格式,請在 Session Manager Broker 組態上設定 session-screenshot-format 參數。請參閱《Amazon DCV Session Manager 管理員指南》中的代理程式組態檔案

未指定GetSessionScreenshots請求的 MaxWidthMaxHeight 參數時,將使用 Session Manager Broker 組態檔案中設定的 session-screenshot-max-widthsession-screenshot-max-height值。若要修改這些參數,另請參閱《Amazon DCV Session Manager 管理員指南》中的代理程式組態檔案

螢幕擷取畫面解析度的上限值僅限於遠端工作階段解析度。如果 MaxWidthMaxHeight 參數設定為高於目前遠端工作階段解析的值,產生的螢幕擷取畫面將僅限於實際工作階段解析。

注意

若要從存取主控台修改這些值,請參閱《Amazon DCV 存取主控台管理員指南》中的 Web 用戶端組態檔案。若要使用 Session Manager CLI 修改這些值,請參閱《Amazon DCV CLI 指南get-session-screenshots》中的 。

請求參數

SessionId

要從中取得螢幕擷取畫面的 Amazon DCV 工作階段 ID。

類型:字串

必要:是

MaxWidth

工作階段螢幕擷取畫面的最大寬度,以像素為單位。如果未指定,將套用來自 Session Manager Broker 組態的值。如果提供,這必須是大於 0 的數字。

類型:整數

必要:否

MaxHeight

工作階段螢幕擷取畫面的最大高度,以像素為單位。如果未指定,將套用來自 Session Manager Broker 組態的值。如果提供,這必須是大於 0 的數字。

類型:整數

必要:是

回應參數

RequestId

請求的唯一 ID。

SuccessfulList

成功螢幕擷取畫面的相關資訊。此資料結構包含下列巢狀回應參數:

SessionScreenshot

螢幕擷取畫面的相關資訊。此資料結構包含下列巢狀回應參數:

SessionId

擷取螢幕擷取畫面的 Amazon DCV 工作階段 ID。

Images

映像的相關資訊。此資料結構包含下列巢狀回應參數:

Format

映像的格式。可能的值包括:jpegpng

Data

螢幕擷取畫面影像 base64 編碼格式。

CreationTime

擷取螢幕擷取畫面的日期和時間。

Primary

指出螢幕擷取畫面是否為 Amazon DCV 工作階段的主要顯示畫面。

UnsuccessfulList

有關失敗螢幕擷取畫面的資訊。此資料結構包含下列巢狀回應參數:

GetSesionScreenshotRequestData

失敗的原始請求。

SessionId

擷取螢幕擷取畫面的 Amazon DCV 工作階段 ID。

FailureReason

失敗的原因。

GetSessionScreenshotRequestData

失敗的原始請求。

範例

Python
請求

下列範例會從兩個工作階段 (sessionId1sessionId2) 取得螢幕擷取畫面,其最大寬度設定為 800,最大高度設定為 600。工作階段sessionId2不存在,並導致失敗。

from swagger_client.models.describe_servers_request_data import GetSessionScreenshotRequestData def get_sessions_api(): api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration())) set_request_headers(api_instance.api_client) return api_instance def get_session_screenshots(session_ids, max_width=None, max_height=None): request = [GetSessionScreenshotRequestData(session_id=session_id, max_width=max_width, max_height=max_height) for session_id in session_ids] print('Get Session Screenshots Request:', request) api_instance = get_sessions_api() api_response = api_instance.get_session_screenshots(body=request) print('Get Session Screenshots Response:', api_response) def main(): get_session_screenshots(["sessionId1", "sessionId2"]), 800, 600)
回應

以下是範例輸出。

{ "RequestId": "542735ef-f6ab-47d8-90e5-23df31d8d166", "SuccessfulList": [ { "SessionScreenshot": { "SessionId": "sessionId1", "Images": [ { "Format": "png", "Data": "iVBORw0KGgoAAAANSUhEUgAAAEXAMPLE", "CreationTime": "2021-03-30T15:47:06.822Z", "Primary": true } ] } } ], "UnsuccessfulList": [ { "GetSessionScreenshotRequestData": { "SessionId": "sessionId2" }, "FailureReason": "Dcv session not found." } ] }