Obtains the screenshots of an Elastic Compute Service (ECS) instance.
Operation description
After ECS returns a Base64-encoded instance screenshot in the JPG format, you must decode the screenshot. We recommend that you call this operation for troubleshooting and diagnosis. When you call this operation, take note of the following items:
- The instance must be in the Running state.
- For instances of the retired instance types, you cannot obtain screenshots. For more information, see Retired instance types.
- If you call this operation on an instance for multiple times, the call interval must be at least 10 seconds. Otherwise, the
Throttling
error is returned.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. | cn-shenzhen |
InstanceId | string | Yes | The instance ID. | i-bp1gbz20g229bvu5**** |
WakeUp | boolean | No | Specifies whether to wake up the hibernated instance. Default value: false. | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InstanceId": "i-bp1gbz20g229bvu5****",
"Screenshot": "iVBORw0KGgoA...AAABJRU5ErkJggg=="
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParameter | %s | A parameter is not specified. |
404 | InvalidParameter | %s | The specified parameter is invalid. |
405 | IncorrectInstanceStatus | %s | The instance is in a state that does not support the current operation. |
405 | NotSupported | %s | Your operation is invalid. |
429 | Throttling | %s | Your request is being throttled. |
For a list of error codes, visit the Service error codes.