云服务器
云服务器
云服务器
文档指南
请输入
云服务器ECS
产品动态
产品公告
实例停售相关
OpenAPI相关
价格和配额相关
功能下线相关
产品计费
快速入门
用户指南
实例
实例规格清单
选择实例计费方式
登录实例
镜像
公共镜像
自定义镜像
镜像维护周期与EOL应对方案
弹性块存储
快照
网络
监控
运维
云助手
运维编排
管理常用运维任务
补丁管理
最佳实践
AI应用
ArkClaw
OpenClaw
通过应用模板快速部署OpenClaw
通过市场镜像快速部署OpenClaw
手动部署OpenClaw
自助建站
搭建环境
搭建应用
搭建网站
管理Linux实例软件源
性能测试
实例配置
搭建Windows操作系统AD域服务
Windows多用户登录
实例数据
监控
镜像
Linux内核调优
故障处理
远程登录问题
Linux操作系统问题
Windows操作系统问题
操作系统问题
veLinux操作系统问题
Linux操作系统问题
Windows操作系统问题
制作自定义镜像问题
实例无法启动问题
实例负载高问题
网络连接问题
存储类问题
云盘问题
第三方软件问题
API参考
实例
镜像
高性能计算集群
密钥对
标签
云盘
预留存储容量包
快照
自动快照策略
监控
部署集
启动模版
云助手
补丁管理
专有宿主机DDH
产品动态
图说专有宿主机
用户指南
API参考
专有宿主机
相关视频
- 文档首页
云服务器云服务器ECSAPI参考运维GetConsoleScreenshot - 获取屏幕截图
复制全文
下载 pdfGetConsoleScreenshot - 获取屏幕截图
文档反馈
问问助手调用 GetConsoleScreenshot 接口，获取正在运行实例的JPG格式屏幕截图。
注意事项
- 仅支持获取运行中状态实例的屏幕截图。
- 暂不支持弹性裸金属型规格的实例。
- 返回的内容是Base64编码后的JPG图像格式的实例截屏，您需要自行解码。
- 本接口存在请求频率限制，建议两次请求间隔10s左右，避免请求频率超过接口限制。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：GetConsoleScreenshot
要执行的操作，取值：GetConsoleScreenshot。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
InstanceId string 必选 示例值：i-3tiefmkskq3vj0******
WakeUp boolean 可选 示例值：false
是否唤醒处于休眠状态的实例。取值：
- true：唤醒处于休眠状态的实例。
- false（默认）：不唤醒处于休眠状态的实例。
返回参数
InstanceId string 示例值：i-3tiefmkskq3vj0******
实例ID。
Screenshot string 示例值：/9j/2wCEAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKC******
Base64编码后的JPG图像格式的实例截屏。
说明
您可以为返回值加前缀 data:image/jpeg;base64,直接在浏览器打开截图。
请求示例
GET /?Action=GetConsoleScreenshot&Version=2020-04-01&InstanceId=i-3tiefmkskq3vj0****** HTTP/1.1
Host: ecs.cn-beijing.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******"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidInstanceStatus | The status of the specified instance does not support this request. | 当前实例的状态不支持此操作。 |
400 | InvalidInstanceTypeForGetConsoleScreenshot.Unsupported | The specified InstanceType does not support get instance console screenshot. | 指定的实例类型不支持获取屏幕截图。 |
400 | MissingParameter.InstanceId | The required parameter InstanceId is not supplied. | 参数实例ID不能为空。 |
404 | InvalidInstance.NotFound | The specified instance does not exist. | 指定的实例不存在。 |
429 | FlowLimitExceeded | You've reach the limit on request rate of resources. | 您已超过资源请求限速。 |
500 | InternalError | An internal error has occurred. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
最近更新时间：2025.09.04 16:54:57
这个页面对您有帮助吗？
有用
有用
无用
无用