调用GetInstanceScreenshot获取实例的截屏信息。

接口说明

云服务器ECS返回Base64编码后的JPG图像格式的实例截屏后，您需要自行解码。您可以在排查故障时调用该接口，并请注意：

  • 实例必须处于运行中（Running）状态。
  • 已停售的实例规格无法获取截屏信息。
  • 在同一台实例中多次调用该接口时，调用的间隔时间至少10秒，否则将返回错误码Throttling。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetInstanceScreenshot

系统规定参数。取值：GetInstanceScreenshot
InstanceId String 是 i-bp1gbz20g229bvu5****

实例ID。
RegionId String 是 cn-shenzhen

实例所在地域ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

WakeUp Boolean 否 false

是否唤醒处于休眠状态的实例。

默认值：false

返回数据

名称 类型 示例值 描述
InstanceId String i-bp1gbz20g229bvu5****

实例ID。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。
Screenshot String iVBORw0KGgoA...AAABJRU5ErkJggg==

JPG图像格式的实例截屏，返回Base64编码后的图像。

示例

请求示例

http://ecs-cn-hangzhou.example.com/?Action=GetInstanceScreenshot
&InstanceId=i-bp1gbz20g229bvu5****
&RegionId=cn-shenzhen
&WakeUp=false
&<公共请求参数>

正常返回示例

XML 格式 

<GetInstanceScreenshotResponse>
      <RequestId>22A1933F-AD02-4560-A6A7-53CF2231D942</RequestId>
      <InstanceId>i-bp1gbz20g229bvu5****</InstanceId>
      <Screenshot>iVBORw0KGgoA...AAABJRU5ErkJggg==</Screenshot>
</GetInstanceScreenshotResponse>

JSON 格式 

{
    "RequestId": "22A1933F-AD02-4560-A6A7-53CF2231D942",
    "InstanceId": "i-bp1gbz20g229bvu5****",
    "Screenshot": "iVBORw0KGgoA...AAABJRU5ErkJggg=="
}

错误码

HttpCode 错误码 错误信息 描述
400 MissingParameter %s 缺失参数，请检查参数是否完整。
404 InvalidParameter %s 无效的参数。
405 IncorrectInstanceStatus %s 当前实例的状态不支持此操作。
405 NotSupported %s 您当前的操作无效。
429 Throttling %s 请求被流控。

访问错误中心查看更多错误码。