Operation description
- After you run a command, it may not succeed. You can call this operation to query the execution result.
- You can query the information about execution in the last two weeks. A maximum of 100,000 lines of execution information can be retained.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| ecd:DescribeInvocations | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available. | cn-hangzhou |
| InvokeId | string | No | The execution ID of the command. You can obtain the value by calling the RunCommand operation. | t-hz0jdfwd9f**** |
| CommandType | string | No | The command type. Valid values:
| RunPowerShellScript |
| InvokeStatus | string | No | The execution status of the command. The value of this parameter is determined by the execution states of the command on all participating cloud computers. Valid values:
| Finished |
| DesktopId | string | No | The cloud computer ID. If you specify a cloud computer, all command execution records of the cloud computer are queried. | ecd-7w78ozhjcwa3u**** |
| IncludeOutput | boolean | No | Specifies whether to return command outputs in the response. Valid values:
| false |
| ContentEncoding | string | No | The encoding method of the command content and outputs. Valid values:
| PlainText |
| MaxResults | integer | No | The number of entries per page.
| 10 |
| NextToken | string | No | The query token. Set the value to the NextToken value that is returned from the last call to the previous DescribeInvocations operation. | AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
| EndUserId | string | No | The user ID. | test1 |
| DesktopIds | array | No | The cloud computer IDs. Note
The DesktopId parameter will be deprecated. We recommend using the DesktopIds parameter to specify cloud computer IDs instead.
| |
| string | No | The cloud computer ID. | ecd-84mztzatmipf2**** | |
| IncludeInvokeDesktops | boolean | No | Specifies whether to return the execution results of the remote command on all cloud computers when executed across multiple cloud computers. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Invocations": [
{
"InvokeId": "t-hz0jdfwd9f****",
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"CommandType": "RunPowerShellScript",
"InvocationStatus": "Pending",
"CreationTime": "2020-12-19T09:15:46Z",
"EndUserId": "User1",
"InvokeDesktops": [
{
"InvocationStatus": "Success",
"Output": "OutPutTestmsg",
"CreationTime": "2020-12-20T06:15:54Z",
"UpdateTime": "2020-12-25T06:15:56Z",
"Repeats": 0,
"DesktopId": "ecd-7w78ozhjcwa3u****",
"Dropped": 0,
"StartTime": "2020-12-20T06:15:55Z",
"StopTime": "2020-12-25T09:15:47Z",
"FinishTime": "2020-12-20T06:15:56Z",
"ExitCode": 0,
"ErrorCode": "InstanceNotExists",
"ErrorInfo": "The specified instance does not exist.",
"DesktopName": "demo1234"
}
],
"InvokeDesktopCount": 1,
"InvokeDesktopSucceedCount": 1
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-13 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-05-18 | The response structure of the API has changed | View Change Details |
| 2022-10-18 | The request parameters of the API has changed | View Change Details |
| 2022-09-29 | The request parameters of the API has changed | View Change Details |