Queries the command output of an Elastic Compute Service (ECS) instance. The returned command output is encoded in Base64.
Operation description
- ECS is a virtualized cloud-based service and cannot be connected to display devices. Alibaba Cloud caches system command outputs for the last start, restart, or shutdown of ECS instances. You can call the GetInstanceConsoleOutput operation to query the command outputs.
- For instances of the retired instance types, you cannot obtain command outputs. For more information, see Retired instance types.
- You cannot obtain the command outputs of Windows instances.
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-hangzhou |
InstanceId | string | Yes | The instance ID. | i-bp1c1xhsrac2coiw**** |
RemoveSymbols | boolean | No | Specifies whether to remove formatting symbols from the returned command output. Valid values:
Default value: false. | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"LastUpdateTime": "2018-03-22 10:04:57",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"InstanceId": "i-bp1c1xhsrac2coiw****",
"ConsoleOutput": "V2VsY29tZSB0byBDZW50T1MgCgpDaGVja2luZyBmaWxlc3lzdGVtcwpDaGVja2luZyBhbGwgZmlsZSBzeXN0ZW1zLgpbL3NiaW4vZnNjay5leHQ0ICgxKSAtLSAvXSBmc2NrLmV4dDQgLWEgL2Rldi92ZGExIAovZGV2L3ZkYTE6IGNsZWFuLCAzMjAxNi8yNjIxNDQwIGZpbGVzLCA0NDc5NzQvMTA0ODU1MDQgYmxvY2tzCgpFbnRlcmluZyBub24taW50ZXJhY3RpdmUgc3RhcnR1cApDYWxsaW5nIHRoZSBzeXN0ZW0gYWN0aXZpdHkgZGF0YSBjb2xsZWN0b3IgKHNhZGMpLi4uIAoKQnJpbmdpbmcgdXAgaW50ZXJmYWNlIGV0aDA6ICAKRGV0ZXJtaW5pbmcgSVAgaW5mb3JtYXRpb24gZm9yIGV0aDAuLi4gZG9uZS4KCmFsaXl1bi1zZXJ2aWNlIHN0YXJ0L3J1bm5pbmcsIHByb2Nlc3MgMTczMwpmaW5pc2hlZAoKQ2VudE9TIHJlbGVhc2UgNi44IChGaW5hbCkKS2VybmVsIDIuNi4zMi02OTYuMy4yLmVsNi5pNjg2IG9uIGFuIGk2ODYKCmlaMnplZDk2ZTQ2MmF5cjBxeioqKioqIGxvZ2luOg=="
}
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.