ListOtaTask API Reference for OTA Update Tasks - App Streaming - Alibaba Cloud - App Streaming

Queries the history of over-the-air updates.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

appstreaming:ListAppInstanceGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	Yes	The number of query results per page. Valid values: 1 to 100.	10
PageNumber	integer	Yes	The page number of the query results to display.	1
AppInstanceGroupId	string	Yes	The delivery group ID.	aig-53fvrq1oanz6c****
OtaType	string	Yes	The type of the over-the-air update task. Valid values: Fota : Wuying system component update.	Fota

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of over-the-air update tasks.	6
PageSize	integer	The number of query results per page.	10
PageNumber	integer	The page number of the query results to display.	1
TaskList	array<object>	The list of over-the-air update tasks.
	object	The over-the-air update task.
OtaVersion	string	The OTA version.	0.0.1-R-20220708.110604
TaskDisplayStatus	string	The task status. Valid values: FAILED : Update failed. RUNNING : Update in progress. TERMINATED : Update stopped. PART_FINISHED : Update partially succeeded. STANDBY : Waiting for update. FINISHED : Update succeeded.	RUNNING
TaskStartTime	string	The task start time in ISO 8601 format.	2022-08-04T14:36:00+08:00
TaskId	string	The task ID.	ota-be7jzm29wrrz5****

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 6,
  "PageSize": 10,
  "PageNumber": 1,
  "TaskList": [
    {
      "OtaVersion": "0.0.1-R-20220708.110604",
      "TaskDisplayStatus": "RUNNING",
      "TaskStartTime": "2022-08-04T14:36:00+08:00",
      "TaskId": "ota-be7jzm29wrrz5****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.