GetInstanceScreenshot_云服务器 ECS_API文档

2014-05-26

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:GetInstanceScreenshot	Get	Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-shenzhen参考取值来源: DescribeRegions
InstanceIdstring	实例 ID。示例值:i-bp1gbz20g229bvu5****参考取值来源: RunInstances StopInstances StartInstances CreateInstance RebootInstances DescribeInstances ModifyManagedInstance RenewReservedInstances DetachInstanceRamRole AttachInstanceRamRole DeregisterManagedInstance PurchaseReservedInstancesOffering
WakeUpboolean	是否唤醒处于休眠状态的实例。展开详情示例值:false

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceIdstring	实例 ID。示例值:i-bp1gbz20g229bvu5****
Screenshotstring	JPG 图像格式的实例截屏，返回 Base64 编码后的图像。示例值:iVBORw0KGgoA...AAABJRU5ErkJggg==

返回示例

错误返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	MissingParameter	%s	诊断
404	InvalidParameter	%s	诊断
405	IncorrectInstanceStatus	%s	诊断
405	NotSupported	%s	诊断
429	Throttling	%s	诊断

变更历史

暂无变更历史

相关示例