使用GetInstanceScreenshot获取实例的截屏信息-云服务器 ECS-阿里云-云服务器 ECS(ECS)-阿里云帮助中心

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:GetInstanceScreenshot

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-shenzhen
RegionId	string	是	实例所在地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-shenzhen
InstanceId	string	是	实例 ID。	i-bp1gbz20g229bvu5****
WakeUp	boolean	否	是否唤醒处于休眠状态的实例。默认值：false	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceId	string	实例 ID。	i-bp1gbz20g229bvu5****
Screenshot	string	JPG 图像格式的实例截屏，返回 Base64 编码后的图像。	iVBORw0KGgoA...AAABJRU5ErkJggg==

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceId": "i-bp1gbz20g229bvu5****",
  "Screenshot": "iVBORw0KGgoA...AAABJRU5ErkJggg=="
}

异常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	%s	缺失参数，请检查参数是否完整。
404	InvalidParameter	%s
405	IncorrectInstanceStatus	%s
405	NotSupported	%s	您当前的操作无效。
429	Throttling	%s

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

变更历史

更多信息，参考变更详情。