Queries the execution results of one or more Cloud Assistant commands on Elastic Compute Service (ECS) instances.
Usage notes
After you run a command, the command may fail to run or may return unexpected results. You can call this operation to query the execution result of a command.
You can query information about command executions within the last four weeks. Up to 100,000 pieces of execution information can be retained.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | DescribeInvocationResults | The operation that you want to perform. Set the value to DescribeInvocationResults. |
RegionId | String | Yes | cn-hangzhou | The region ID of the command. You can call the DescribeRegions operation to query the most recent region list. |
ResourceGroupId | String | No | rg-bp67acfmxazb4p**** | The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried. |
InvokeId | String | No | t-hz0jdfwd9f**** | The ID of the command task. You can call the DescribeInvocations operation to query the IDs of all command tasks. |
InstanceId | String | No | i-bp1i7gg30r52z2em**** | The instance ID. |
CommandId | String | No | c-hz0jdfwcsr**** | The command ID. |
InvokeRecordStatus | String | No | Running | The state of the command task. Valid values:
|
IncludeHistory | Boolean | No | false | Specifies whether to return the results of historical scheduled executions. Valid values:
Default value: false. |
ContentEncoding | String | No | PlainText | The encoding mode of the
Default value: Base64. |
PageNumber | Long | No | 1 | The page number. Pages start from page 1. Default value: 1. |
PageSize | Long | No | 1 | The number of entries per page. Valid values: 1 to 50. Default value: 10. |
Tag.N.Key | String | No | TestKey | The key of tag N of the command task. Valid values of N: 1 to 20. The tag key cannot be an empty string. If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags, call the ListTagResources operation. The tag key can be up to 64 characters in length and cannot start with |
Tag.N.Value | String | No | TestValue | The value of tag N of the command task. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain |
Response parameters
Parameter | Type | Example | Description |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE***** | The request ID. |
Invocation | Object | Details about the execution results. | |
PageSize | Long | 1 | The number of entries per page. |
PageNumber | Long | 1 | The page number. |
TotalCount | Long | 1 | The total number of commands. |
InvocationResults | Array of InvocationResult | The execution results. | |
InvocationResult | |||
InvocationStatus | String | Success | The execution state on a single instance. Valid values:
|
Repeats | Integer | 0 | The number of times that the command was run on the instance.
|
CommandId | String | c-hz0jdfwcsr**** | The command ID. |
InstanceId | String | i-bp1i7gg30r52z2em**** | The instance ID. |
Output | String | MTU6MzA6MDEK | The command output.
|
Dropped | Integer | 0 | The size of the Output text that is truncated and discarded when the |
StopTime | String | 2020-01-19T09:15:47Z | The time when the command task was stopped. If you call the |
ExitCode | Long | 0 | The exit code of the command task.
|
StartTime | String | 2019-12-20T06:15:55Z | The time when the command started to be run on the instance. |
ErrorInfo | String | the specified instance does not exists | The error message returned when the command failed to be sent or run. Valid values:
|
ErrorCode | String | InstanceNotExists | The error code returned when the command failed to be sent or run. Valid values:
|
FinishedTime | String | 2019-12-20T06:15:56Z | The completion time of the command task. If the command task times out, the end time is equal to the start time of the command task specified by |
InvokeId | String | t-hz0jdfwd9f**** | The ID of the command task. |
InvokeRecordStatus | String | Running | The state of the command task. Valid values:
|
Username | String | test | The username that was used to run the command on the instance. |
ContainerId | String | ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** | The ID of the container. |
ContainerName | String | test-container | The container name. |
Tags | Array of Tag | The tag of the command task. | |
Tag | |||
TagKey | String | owner | The tag key of the command task. |
TagValue | String | zhangsan | The tag value of the command task. |
Examples
Sample requests
http(s)://ecs.aliyuncs.com/?Action=DescribeInvocationResults
&RegionId=cn-hangzhou
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=1
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInvocationResultsResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE*****</RequestId>
<Invocation>
<InvocationResults>
<InvocationResult>
<Dropped>0</Dropped>
<InvocationStatus>Success</InvocationStatus>
<InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
<ExitCode>0</ExitCode>
<ErrorInfo>the specified instance does not exists</ErrorInfo>
<StartTime>2019-12-20T06:15:55Z</StartTime>
<Repeats>0</Repeats>
<InvokeRecordStatus>Running</InvokeRecordStatus>
<FinishedTime>2019-12-20T06:15:56Z</FinishedTime>
<Output>MTU6MzA6MDEK</Output>
<CommandId>c-hz0jdfwcsr****</CommandId>
<ErrorCode>InstanceNotExists</ErrorCode>
<InvokeId>t-hz0jdfwd9f****</InvokeId>
<StopTime>2020-01-19T09:15:47Z</StopTime>
<Username>test</Username>
<ContainerId>ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****</ContainerId>
<ContainerName>test-container</ContainerName>
<Tags>
<TagKey>owner</TagKey>
<TagValue>zhangsan</TagValue>
</Tags>
</InvocationResult>
</InvocationResults>
<TotalCount>1</TotalCount>
<PageSize>1</PageSize>
<PageNumber>1</PageNumber>
</Invocation>
</DescribeInvocationResultsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
"Invocation" : {
"InvocationResults" : {
"InvocationResult" : [ {
"Dropped" : 0,
"InvocationStatus" : "Success",
"InstanceId" : "i-bp1i7gg30r52z2em****",
"ExitCode" : 0,
"ErrorInfo" : "the specified instance does not exists",
"StartTime" : "2019-12-20T06:15:55Z",
"Repeats" : 0,
"InvokeRecordStatus" : "Running",
"FinishedTime" : "2019-12-20T06:15:56Z",
"Output" : "MTU6MzA6MDEK",
"CommandId" : "c-hz0jdfwcsr****",
"ErrorCode" : "InstanceNotExists",
"InvokeId" : "t-hz0jdfwd9f****",
"StopTime" : "2020-01-19T09:15:47Z",
"Username" : "test",
"ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName" : "test-container",
"Tags" : [ {
"TagKey" : "owner",
"TagValue" : "zhangsan"
} ]
} ]
},
"TotalCount" : 1,
"PageSize" : 1,
"PageNumber" : 1
}
}
Error codes
HTTP status code | Error code | Error message | Description |
400 | RegionId.ApiNotSupported | The api is not supported in this region. | This operation cannot be performed in the specified region. Check whether the region ID is valid. |
400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | The tag key already exists. Tag keys must be unique. |
400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | Invalid Tag.N.Key value. |
400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | Invalid Tag.N.Value value. |
400 | MissingParameter.TagKey | You must specify Tag.N.Key. | Tag.N.Key is required. |
400 | InvalidParam.PageNumber | The specified parameter is invalid. | Invalid PageNumber value. |
400 | InvalidParam.PageSize | The specified parameter is invalid. | Invalid PageSize value. |
403 | Operation.Forbidden | The operation is not permitted. | The operation is not supported. |
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | An error occurred while the request was being sent. Try again later. |
500 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | The request failed due to a temporary failure of the backend server. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error occurred. Try again later. |
For a list of error codes, see Service error codes.