GetInstanceScreenshot - Elastic Compute Service

介面說明

雲端伺服器 ECS 返回 Base64 編碼後的 JPG 圖像格式的執行個體截圖後，您需要自行解碼。您可以在排查故障時呼叫該介面，並請注意：

執行個體必須處於運行中（Running）狀態。
已停售的執行個體規格無法取得截圖資訊。
在同一台執行個體中多次呼叫該介面時，呼叫的間隔時間至少 10 秒，否則將返回錯誤碼Throttling。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:GetInstanceScreenshot

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所在地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-shenzhen
InstanceId	string	是	執行個體所在地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	i-bp1gbz20g229bvu5****
WakeUp	boolean	否	執行個體 ID。	false
		否	是否喚醒處於休眠狀態的執行個體。預設值：false。

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceId	string	執行個體 ID。	i-bp1gbz20g229bvu5****
Screenshot	string	JPG 圖像格式的執行個體截圖，返回 Base64 編碼後的圖像。	iVBORw0KGgoA...AAABJRU5ErkJggg==

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceId": "i-bp1gbz20g229bvu5****",
  "Screenshot": "iVBORw0KGgoA...AAABJRU5ErkJggg=="
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	MissingParameter	%s
404	InvalidParameter	%s
405	IncorrectInstanceStatus	%s
405	NotSupported	%s
429	Throttling	%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。