You can call this operation to query the execution list and status of Cloud Assistant commands.
Description
- After you run a command, it may not succeed. You must call the operation to query the actual execution result.
- You can query the execution information within the past two weeks. A maximum of 100,000 pieces of execution information can be retained.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInvocations |
The operation that you want to perform. Set the value to DescribeInvocations. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the command. You can call the DescribeRegions operation to query the most recent region list. |
InvokeId | String | No | t-hz0jdfwd9f**** |
The ID of the execution. |
CommandId | String | No | c-hz0jdfwcsr**** |
The ID of the command. You can call the DescribeCommands operation to query all available command IDs. |
CommandName | String | No | CommandTestName |
The name of the command. |
CommandType | String | No | RunShellScript |
The type of the command. |
Timed | Boolean | No | true |
Specifies whether to run the command on a scheduled basis. Default value: false. |
InvokeStatus | String | No | Finished |
The overall execution status of the command. The value of this parameter depends on
the overall execution status of the command on all the involved instances (
Default value: Running. |
InstanceId | String | No | i-bp1i7gg30r52z2em**** |
The ID of the instance. When you specify this parameter, the system queries all the command execution records of the instance. |
ContentEncoding | String | No | PlainText |
The encoding method of the
Default value: Base64. |
IncludeOutput | Boolean | No | false |
Specifies whether to return the execution output information in the result.
Default value: false. |
PageNumber | Long | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Long | No | 10 |
The number of entries to return on each page. Maximum value: 50. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Invocations | Array |
Details about the command execution records. |
|
Invocation | |||
CommandContent | String | cnBtIC1xYSB8IGdyZXAgdnNm**** |
The Base64-encoded command content. |
CommandId | String | c-hz0jdfwcsr**** |
The ID of the command. |
CommandName | String | CommandTestName |
The name of the command. |
CommandType | String | RunShellScript |
The type of the command. |
CreationTime | String | 2020-01-19T09:15:46Z |
The time when the task was created. |
Frequency | String | 0 */20 * * * * |
The execution cycle of the scheduled invocation. For more information about the value specifications, see Cron expression. |
InvocationStatus | String | Pending |
The overall execution status of the command. The value of this parameter depends on the overall execution status on all the involved instances. Valid values:
|
InvokeId | String | t-hz0jdfwd9f**** |
The ID of the execution. |
InvokeInstances | Array |
Details about the instances on which the command is executed. |
|
InvokeInstance | |||
CreationTime | String | 2019-12-20T06:15:54Z |
The time when the command execution was created. |
Dropped | Integer | 0 |
The size of truncated and discarded text when the size of text in the Output field is larger than 24 KB. |
ErrorCode | String | InstanceNotExists |
The code for the cause why a command fails to be sent or executed. Valid values:
|
ErrorInfo | String | the specified instance does not exists |
The detailed cause why a command fails to be sent or executed. Valid values:
|
ExitCode | Long | 0 |
The exit code of the command execution. Valid values:
|
FinishTime | String | 2019-12-20T06:15:56Z |
The end time of the command execution. |
InstanceId | String | i-bp1i7gg30r52z2em**** |
The ID of the instance. |
InstanceInvokeStatus | String | Finished |
The command execution status on a single instance. Valid values:
|
InvocationStatus | String | Success |
The command execution progress on a single instance. Valid values:
|
Output | String | OutPutTestmsg |
The output of the command execution. |
Repeats | Integer | 0 |
The number of executions on the instance.
|
StartTime | String | 2019-12-20T06:15:55Z |
The time when the command started to be executed on the instance. |
StopTime | String | 2020-01-19T09:15:47Z |
The time when you called the |
UpdateTime | String | 2020-01-19T09:15:47Z |
The time when the task status was updated. |
InvokeStatus | String | Finished |
The overall execution status of the command. Note We recommend that you ignore this parameter and check the returned values of the
InvocationStatus parameter.
|
Parameters | String | {} |
The custom parameters in the command. |
Timed | Boolean | false |
Indicates whether the command is run on a scheduled basis. |
PageNumber | Long | 1 |
The page number of the returned page. |
PageSize | Long | 10 |
The number of entries returned per page. |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
The ID of the request. |
TotalCount | Long | 2 |
The total number of commands. |
Examples
Sample requests
https://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-hz0jdfwd9f****
&CommandId=c-hz0jdfwcsr****
&CommandName=CommandTestName
&CommandType=RunShellScrip
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=10
&<Common request parameters>
Sample success responses
XML
format
<DescribeInvocationsResponse>
<TotalCount>5</TotalCount>
<RequestId>634562E9-F291-4289-B60B-FC511A43CD34</RequestId>
<PageSize>1</PageSize>
<PageNumber>1</PageNumber>
<Invocations>
<Invocation>
<CommandContent>cnBtIC1xYSB8IGdyZXAgdnNm****</CommandContent>
<InvocationStatus>Failed</InvocationStatus>
<InvokeStatus>Finished</InvokeStatus>
<Parameters>{}</Parameters>
<CommandType>RunShellScript</CommandType>
<Timed>false</Timed>
<CreationTime>2020-05-11T09:01:39Z</CreationTime>
<Frequency></Frequency>
<CommandId>c-hz0jdfwcsr****</CommandId>
<CommandName>AutoTest</CommandName>
<InvokeId>t-hz0jdfwd9f****</InvokeId>
<InvokeInstances>
<InvokeInstance>
<Dropped>0</Dropped>
<InvocationStatus>Failed</InvocationStatus>
<InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
<InstanceInvokeStatus>Finished</InstanceInvokeStatus>
<ExitCode>1</ExitCode>
<ErrorInfo>the command execution exit code is not zero. </ErrorInfo>
<StartTime>2020-05-11T09:01:40Z</StartTime>
<Repeats>1</Repeats>
<FinishTime>2020-05-11T09:01:41Z</FinishTime>
<Output></Output>
<CreationTime>2020-05-11T09:01:39Z</CreationTime>
<UpdateTime>2020-05-11T09:01:41Z</UpdateTime>
<ErrorCode>ExitCodeNonzero</ErrorCode>
<StopTime></StopTime>
</InvokeInstance>
</InvokeInstances>
</Invocation>
</Invocations>
</DescribeInvocationsResponse>
JSON
format
{
"TotalCount": 5,
"RequestId": "634562E9-F291-4289-B60B-FC511A43CD34",
"PageSize": 1,
"PageNumber": 1,
"Invocations": {
"Invocation": [
{
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"InvocationStatus": "Failed",
"InvokeStatus": "Finished",
"Parameters": "{}",
"CommandType": "RunShellScript",
"Timed": false,
"CreationTime": "2020-05-11T09:01:39Z",
"Frequency": "",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "AutoTest",
"InvokeId": "t-hz0jdfwd9f****",
"InvokeInstances": {
"InvokeInstance": [
{
"Dropped": 0,
"InvocationStatus": "Failed",
"InstanceId": "i-bp1i7gg30r52z2em****",
"InstanceInvokeStatus": "Finished",
"ExitCode": 1,
"ErrorInfo": "the command execution exit code is not zero.",
"StartTime": "2020-05-11T09:01:40Z",
"Repeats": 1,
"FinishTime": "2020-05-11T09:01:41Z",
"Output": "",
"CreationTime": "2020-05-11T09:01:39Z",
"UpdateTime": "2020-05-11T09:01:41Z",
"ErrorCode": "ExitCodeNonzero",
"StopTime": ""
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | The error message returned because an error occurred when the request was being sent. Try again later. |
403 | InvalidParam.PageNumber | The specified parameter is invalid. | The error message returned because the specified PageNumber parameter is invalid. |
403 | InvalidParam.PageSize | The specified parameter is invalid. | The error message returned because the specified PageSize parameter is invalid. |
For a list of error codes, visit the API Error Center.