You need to enable JavaScript to run this app.
导航

GetConsoleScreenshot

最近更新时间2023.11.20 19:41:14

首次发布时间2023.03.03 08:16:30

调用 GetConsoleScreenshot 接口,获取正在运行实例的JPG格式屏幕截图,以帮助进行故障排查。返回的内容是Base64编码后的JPG图像格式的实例截屏,您需要自行解码。

说明

  • 仅支持获取运行中状态实例的系统日志。
  • 暂不支持弹性裸金属型规格的实例。
  • 本接口存在请求频率限制,建议两次请求间隔10s左右,避免请求频率超过接口限制。

调试

请求参数

名称类型是否必填示例值描述
ActionStringGetConsoleScreenshot要执行的操作,取值:GetConsoleScreenshot。
VersionString2020-04-01接口的版本,取值:2020-04-01。
InstanceIdStringi-3tiefmkskq3vj0****实例ID。您可以调用DescribeInstances接口查询获取实例ID。

WakeUp

Boolean

false

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

  • true:唤醒处于休眠状态的实例。

  • false(默认):不唤醒处于休眠状态的实例。

返回数据

名称类型示例值说明
InstanceIdStringi-3tiefmkskq3vj0****实例ID。

Screenshot

String

/9j/2wCEAAIBAQEBAQIBAQECAgICAgQDAgICGBwkIBgcJBw*******

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

说明

您可以为返回值加前缀 data:image/jpeg;base64, 直接在浏览器打开截图。

请求示例

GET /?Action=GetConsoleScreenshot&Version=2020-04-01&InstanceId=i-3tiefmkskq3vj0****** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "GetConsoleScreenshot",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "i-3tiefmkskq3vj0******",
        "Screenshot": "/9j/2wCEAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKC******"
    }
}

错误码

HttpCode错误码错误信息描述

400

InvalidInstanceStatus

The status of the specified instance does not support this request.

当前实例的状态不支持此操作。

400InvalidInstanceTypeForGetConsoleScreenshot.UnsupportedThe specified InstanceType does not support get instance console screenshot.指定的实例类型不支持获取屏幕截图。
400MissingParameter.InstanceIdThe required parameter InstanceId is not supplied.实例ID不能为空。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
404InvalidInstance.NotFoundThe specified instance does not exist.指定的实例不存在。
429FlowLimitExceededYou've reach the limit on request rate of resources.您已超过资源请求限速。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。