インスタンスのスクリーンショット情報を取得します。
説明
インスタンスのスクリーンショットが、Base64 でエンコードされた JPG 形式で返されます。返されたスクリーンショットは、ユーザー自身でデコードする必要があります。 この操作をトラブルシューティングや診断に使用することを推奨します。次の点を考慮してください。
- インスタンスのステータスは、Running (実行中) でなければなりません。
- フェーズアウトインスタンスタイプの場合、スクリーンショット情報を取得できません。
デバッグ
API Explorer を使用してデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成が可能です。
リクエストパラメーター
名前 | 型 | 必須かどうか | 例 | 説明 |
---|---|---|---|---|
InstanceId | String | はい | i-myInstance | インスタンスの ID。 |
RegionId | String | はい | cn-shenzhen | インスタンスが設置されているリージョンの ID。DescribeRegions を呼び出すと、Alibaba Cloud の最新リージョンが表示されます。 |
Action | String | いいえ | GetInstanceScreenshot | 実行する操作。 値を GetInstanceScreenshot に設定します。 |
WakeUp | Boolean | いいえ | false | スリープモードのインスタンスを起動するかどうか。 デフォルト値:false。 |
レスポンスパラメーター
名前 | 型 | 例 | 説明 |
---|---|---|---|
InstanceId | String | i-myInstance | インスタンスの ID。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | リクエストの ID。 |
Screenshot | String | iVBORw0KGgoA… AAABJRU5ErkJggg== | Base64 でエンコードされた JPG 形式のインスタンスのスクリーンショット。 |
例
リクエストの例
http://ecs-cn-hangzhou.example.com/?Action=GetInstanceScreenshot&InstanceId=i-myInstance&RegionId=cn-shenzhen&WakeUp=false&<Common request parameters>
レスポンスの成功例
XML
形式
<GetInstanceScreenshotResponse> <RequestId>22A1933F-AD02-4560-A6A7-53CF2231D942</RequestId> <InstanceId>i-j5e42sbbthlokka11ech</InstanceId> <Screenshot>iVBORw0KGgoA… AAABJRU5ErkJggg==</Screenshot></GetInstanceScreenshotResponse>
JSON
形式
{ “Screenshot”:”iVBORw0KGgoA… AAABJRU5ErkJggg==”, “InstanceId”:”i-j5e42sbbthlokka11ech”, “RequestId”:”22A1933F-AD02-4560-A6A7-53CF2231D942”}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | MissingParameter | %s | このエラーメッセージは、必須パラメーターが指定されていない場合に返されます。 |
404 | InvalidParameter | %s | このエラーメッセージは、パラメーターの形式が無効な場合に返されます。 |
405 | IncorrectInstanceStatus | %s | このエラーメッセージは、指定したリソースが、この操作でサポートされていないステータスにある場合に返されます。 |