DescribeInvocations - Simple Application Server - Alibaba Cloud Documentation Center

Queries details about command execution.

Operation description

After you execute a command, the command may not succeed or return the expected results. You can call this operation to query the actual execution results.
You can query the execution results that were generated within the last two weeks. Up to 100,000 entries of execution results can be retained.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
swas-open:DescribeInvocations	get	Instance acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The ID of the simple application server.	3a658ca270df4df39f22e289b338****
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
InvokeStatus	string	No	The status of the command execution. Valid values: Running: The command is being executed. Finished: The execution is complete. Failed: The execution fails.	Finished

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
Invocations	array<object>	The command name.
Invocation	object
CreationTime	string	The time when the command was created.	2022-07-11T06:37:16Z
InvocationStatus	string	The status of the command. Valid values: Pending: The command is being verified or sent. Invalid: The specified command type or parameter is invalid. Aborted: The command failed to be sent. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute. Running: The command is being run on the instance. Success: The command finishes running, and the exit code is 0. Failed: The command finishes running, but the exit code is not 0. Error: The running of the command cannot proceed due to an exception. Timeout: The running of the command times out. Cancelled: The running is canceled, and the command is not run. Stopping: The command that is running is being stopped. Terminated: The command is terminated while it is being run.	Success
CommandType	string	The type of the command. Valid values: RunBatScript: batch command (applicable to Windows instances). RunPowerShellScript: PowerShell command (applicable to Windows instances). RunShellScript: shell command (applicable to Linux instances).	RunShellScript
CommandContent	string	The content of the command, which is Base64-encoded.	bHM=
Parameters	object	The custom parameters in the command. If no custom parameter exists in the command, the default value is {}.	{}
InvokeStatus	string	The status of the command. Valid values: Running: The command is running. Finished: The command finishes running. Failed: The running of the command failed. Stopped: The running is stopped.	Finished
InvokeId	string	The ID of the command task.	t-hz02p9545t6****
CommandName	string	The name of the command.	testname
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	10

Examples

Sample success responses

JSONformat

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "Invocations": [
    {
      "CreationTime": "2022-07-11T06:37:16Z",
      "InvocationStatus": "Success",
      "CommandType": "RunShellScript",
      "CommandContent": "bHM=",
      "Parameters": {},
      "InvokeStatus": "Finished",
      "InvokeId": "t-hz02p9545t6****",
      "CommandName": "testname"
    }
  ],
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 10
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history