獲取執行個體的截屏資訊。
描述
我們返回 Base 64 編碼後的 JPG 映像格式的執行個體截屏,您需要自行解碼。您可以在排查故障時調用該介面,並請注意:
- 執行個體必須處於 運行中(
Running
)狀態。 - 已停售的執行個體規格 無法獲取截屏資訊。
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:GetInstanceScreenshot |
RegionId | String | 是 | 執行個體所在地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。 |
InstanceId | String | 是 | 執行個體 ID。 |
Wakeup | Boolean | 否 | 是否喚醒處於休眠狀態的執行個體。 預設值:false |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
InstanceId | String | 執行個體 ID |
Screenshot | String | JPG 映像格式的執行個體截屏,返回 Base 64 編碼後的映像 |
樣本
請求樣本
http://ecs-cn-hangzhou.example.com/?Action=GetInstanceScreenshot
&RegionId=cn-shenzhen
&InstanceId=i-j5e42sbbthlokka11eci
&Wakeup=False
&<公共請求參數>
正常返回樣本
XML 格式
<GetInstanceScreenshotResponse>
<RequestId>22A1933F-AD02-4560-A6A7-53CF2231D942</RequestId>
<InstanceId>i-j5e42sbbthlokka11ech</InstanceId>
<Screenshot>iVBORw0KGgoA...AAABJRU5ErkJggg==</Screenshot>
</GetInstanceScreenshotResponse>
JSON 格式
{
"RequestId": "22A1933F-AD02-4560-A6A7-53CF2231D942",
"InstanceId": "i-j5e42sbbthlokka11ech",
"Screenshot": "iVBORw0KGgoA...AAABJRU5ErkJggg=="
}
異常返回樣本
XML 格式
<Error>
<RequestId>C38E0D94-C18B-44F3-8C05-6E35BE334088</RequestId>
<HostId>ecs.aliyuncs.com</HostId>
<Code>NotSupported</Code>
<Message>The operation is not supported for "i-j5e42sbbthlokkaXXXXX".</Message>
</Error>
JSON 格式
{
"RequestId": "C38E0D94-C18B-44F3-8C05-6E35BE334088",
"HostId": "ecs.aliyuncs.com",
"Code": "NotSupported",
"Message": "The operation is not supported for "i-j5e42sbbthlokkaXXXXX"."
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心 。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
MissingParameter | The input parameter “instanceId” that is mandatory for processing this request is not supplied. | 400 | 您必須指定參數 InstanceId 。 |
InvalidParameter | The “instanceId” provided is not valid. | 404 | 指定的 InstanceId 不存在。 |
IncorrectInstanceStatus | The instance status “{status}” is not applicable | 405 | 執行個體必須處於 運行中(Running )狀態。 |
NotSupported | The operation is not supported for “{instanceId}” | 405 | 已停售的執行個體規格 無法獲取截屏資訊。 |
Throttling | Request was denied due to request throttling. | 429 | 系統流控期間,請稍後再試。 |