All Products
Search
Document Center

Elastic Desktop Service:DescribeFotaTasks

Last Updated:Nov 14, 2025

Queries a list of update tasks.

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.

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 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.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:DescribeFotaTasks
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service.

cn-hangzhou
MaxResultsintegerNo

The number of entries per page.

  • Valid values: 1 to 100
  • Default value: 20
20
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists.

caeba0bbb2be03f84eb48b699f0a4883
TaskUidarrayNo

The IDs of the image update tasks.

stringNo

The ID of the image update task. You can call the DescribeFotaTasks operation to obtain the value of this parameter.

aot-c4khwrp9ocml4****
UserStatusstringNo

Specifies whether to automatically push the image update task.

Valid values:

  • Running: automatically pushes the image update task.
  • Pending: does not automatically push the image update task.
Pending
FotaStatusstringNo
Note This parameter is not publicly available.
To be hidden.
LangstringNo

The language of the image version to update.

Valid values:

  • en: English.
  • zh: Simplified Chinese.
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
FotaTasksarray<object>

Details about the image update task.

FotaTaskobject

Details about the image update task.

TaskUidstring

The ID of the image upgrade task.

aot-c4khwrp9ocml4****
FotaProjectstring
Note This parameter is not publicly available.
To be hidden.
AppVersionstring

The image version. You can call the DescribeImages operation to obtain the value of this parameter.

0.0.1-D-20220513.143129
Statusstring

Indicates whether the image update task is automatically pushed.

Valid values:

  • Running: automatically pushes the image update task.
  • Pending: does not automatically push the image update task.
valid
PublishTimestring

The time when the image version available for update was published.

2022-05-31T04:28:48Z
PendingDesktopCountinteger

The number of cloud computers whose images can be updated to this version.

1
ReleaseNotestring

The description of the image version available for update.

test
Sizeinteger

The size of the update package. Unit: KB.

568533470
PendingCustomImageCountinteger

The number of custom images that can be updated to this version.

1
Codestring

The returned message. If the request was successful, a success is returned. If the request failed, an error message is returned.

success
Messagestring

The returned error message. This parameter is not returned if the Code value is a success message.

success
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.

AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "FotaTasks": [
    {
      "TaskUid": "aot-c4khwrp9ocml4****",
      "FotaProject": "To be hidden.",
      "AppVersion": "0.0.1-D-20220513.143129",
      "Status": "valid",
      "PublishTime": "2022-05-31T04:28:48Z",
      "PendingDesktopCount": 1,
      "ReleaseNote": "test",
      "Size": 568533470,
      "PendingCustomImageCount": 1
    }
  ],
  "Code": "success",
  "Message": "success",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-06The response structure of the API has changedView Change Details
2023-11-23The request parameters of the API has changedView Change Details
2023-03-28The response structure of the API has changedView Change Details
2022-03-15Add OperationView Change Details