Listing Application Objects of an Upgrade Task

Function

Lists application objects of a specified task by page.

Fuzzy match by application object name is supported.
Exact match by task ID is supported.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:upgradeTask:listApplyObjects

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:upgradeTask:listApplyObjects	List	-	-	-	-

URI

GET /v2/{project_id}/upgrade-task/{task_id}/apply-objects

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
task_id	Yes	String	Task ID (exact query).

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
object_name	No	String	Application object name (fuzzy search is supported).
offset	No	Integer	Offset. The default value is 0.
limit	No	Integer	Number of records on each page. The default value is 10, and the maximum value is 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Total quantity.
apply_objects	Array of TaskApplyObjectDetailInfo objects	Application object list.

**Table 4** TaskApplyObjectDetailInfo
Parameter	Type	Description
object_id	String	Object ID.
object_type	String	Object type.
object_name	String	Object name.
object_extra_id	String	Object desktop ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Service error code.
error_msg	String	Service error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Service error code.
error_msg	String	Service error message.

Example Requests

None

Example Responses

Status code: 200

{
  "total_count" : 10,
  "apply_objects" : [ {
    "object_id" : "desktop-001",
    "object_type" : "DESKTOP",
    "object_name" : "Test Desktop 1",
    "object_extra_id" : "desktop-id-001"
  } ]
}