Obtaining an Application List

Function

This API is used to query an application list in a project. This API will not be maintained after September 30, 2024. You can use the ListAllApp API instead.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/tasks/list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	Yes	Integer	Page number, indicating that the query starts from this page. The value of page is no less than 1.
size	Yes	Integer	Number of items displayed on each page. The value of size is no more than 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number
result	Array of TaskInfo objects	Returned result

**Table 5** TaskInfo
Parameter	Type	Description
task_id	String	Deployment task ID
name	String	Application name
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name
deploy_system	String	Deployment type. Options: deployTemplate, ansible, and shell.
create_time	String	Creation time
update_time	String	Modification time
state	String	Application status: Draft and Available.
execution_time	String	Last deployment time
description	String	Description
is_defaut_permission	Boolean	Whether to use the default permission matrix
template_id	String	Template ID
owner	String	Username of the application creator
nick_name	String	Alias of the application creator
owner_id	String	ID of the application creator
tenant_id	String	Tenant ID of the application creator
tenant_name	String	Tenant name of the application creator
slave_cluster_id	String	Slave cluster ID. If the value is null, the default slave cluster is used. If slave is user-defined, the slave cluster ID is used.
is_care	Boolean	Whether you have favorited the application
can_modify	Boolean	Whether you have the edit permission
can_delete	Boolean	Whether you have the delete permission
can_view	Boolean	Whether you have the view permission
can_execute	Boolean	Whether you have the deploy permission
can_copy	Boolean	Whether you have the clone permission
can_manage	Boolean	Whether you have permission to edit the application permission matrix
can_disable	Boolean	Whether you have permission to disable applications
app_component_list	Array of AppComponentDao objects	Mapping between applications and AOM application components
role_id	Integer	Role ID. 0: Application creator. -1: Project creator. 3: Project manager. 4: Developer. 5: Test manager. 6: Tester. 7: Participant. 8: Viewer.
id	String	Deployment task ID
release_id	Integer	Deployment record sequence number
is_disable	Boolean	Whether the application is disabled
duration	String	Deployment time
execution_state	String	Deployment status
executor_id	String	Deployer ID
executor_nick_name	String	Deployer name
steps	Map<String,Step>	Deployment procedure

**Table 6** AppComponentDao
Parameter	Type	Description
task_id	String	Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
app_id	String	Parameter description: AOM application ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
app_name	String	Parameter description: AOM application name. Value range: The value consists of letters and digits.
comp_id	String	Parameter description: AOM application component ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
comp_name	String	Parameter description: AOM application component name. Value range: The value consists of 0 to 128 characters.
domain_id	String	Parameter description: Tenant ID. Value range: The value consists of 32 characters. Letters and digits are allowed.
region	String	Parameter description: Region information. Value range: The value consists of 1 to 256 characters.
state	String	Parameter description: Whether the AOM application component takes effect. Value range: 0: Initialized. 1: The operation is successful and takes effect.

**Table 7** Step
Parameter	Type	Description
id	String	Parameter description: Action ID. Value range: N/A
name	String	Parameter description: Action name. Value range: N/A
params	Map<String,String>	Parameter description: Action parameter. Value range: N/A
enable	Boolean	Parameter description: Whether an action is enabled. Value range: true: Enabled false: Disabled

Example Requests

https://endpoint/v2/332f53cbabc44863a46ce6b4f82a9fe7/tasks/list?page=1&size=2

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "id" : "2c82ffe8d00d4968a4e5f7a36d87ae17",
    "name" : "Message Notification",
    "state" : "succeeded",
    "owner" : "devcloud_devcloud_l00490255_01",
    "duration" : "00:00:50",
    "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7",
    "project_name" : "DeployMan-UI-L0",
    "deploy_system" : "deployTemplate",
    "create_time" : "2022-02-09 16:34:20",
    "update_time" : "2022-03-05 09:04:39",
    "execution_time" : "2022-04-11 15:50:23",
    "execution_state" : "succeeded",
    "role_id" : -1,
    "is_defaut_permission" : false,
    "executor_id" : "6baa7454109d47c192f22078fe6cda20",
    "executor_nick_name" : "A/B Side Account",
    "nick_name" : "A/B Side Account",
    "owner_id" : "6baa7454109d47c192f22078fe6cda20",
    "is_care" : true,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : true,
    "can_disable" : false,
    "release_id" : 61640,
    "is_disable" : true
  }, {
    "id" : "a9c3ef27a1f34a1abf1dc84d927d7d39",
    "name" : "412",
    "state" : "failed",
    "owner" : "paas_clouddeploy_h00472130_01",
    "duration" : "00:02:36",
    "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7",
    "project_name" : "DeployMan-UI-L0",
    "deploy_system" : "deployTemplate",
    "create_time" : "2022-04-12 17:26:07",
    "update_time" : "2022-04-12 17:26:07",
    "execution_time" : "2022-04-13 11:45:09",
    "execution_state" : "failed",
    "role_id" : -1,
    "is_defaut_permission" : false,
    "executor_id" : "04ec4661a8df4359b50980a9c958c86d",
    "executor_nick_name" : "paas_clouddeploy_h00472130_01",
    "nick_name" : "paas_clouddeploy_h00472130_01",
    "owner_id" : "04ec4661a8df4359b50980a9c958c86d",
    "is_care" : false,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : true,
    "can_disable" : false,
    "release_id" : 29,
    "is_disable" : true
  } ],
  "total_num" : 331
}

Status Codes

Status Code	Description
200	OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Applications

Previous topic: Managing Applications

Next topic: Deploying an Application

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.