Help Center> CodeArts Deploy> API Reference> APIs> Application Management> Obtaining an Application List (Recommended)

Updated on 2023-11-28 GMT+08:00

View PDF

Obtaining an Application List (Recommended)

Function

This API is used to query the application list in a project.

URI

POST /v1/applications/list

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Possible values: application/json;charset=utf-8 application/json Default: application/json;charset=utf-8 Enumeration values: application/json;charset=utf-8 application/json
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. Minimum: 0 Maximum: 20000

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum: 32 Maximum: 32
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.
sort_name	No	String	Name of the sorting field. Currently, only name and startTime are supported. Enumeration values: name startTime
sort_by	No	String	Sorting sequence: ascending order (ASC) and descending order (DESC).
states	No	Array of strings	Application status list. The following statuses can be queried: abort, failed, not_started, pending, running, succeeded, timeout, and not_executed. Enumeration values: abort failed not_started pending running succeeded timeout not_executed
group_id	No	String	Application group ID. Enter no_grouped to query ungrouped applications.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number.
result	Array of AppExecutionInfo objects	Application list array.

**Table 4** AppExecutionInfo
Parameter	Type	Description
id	String	Application ID.
name	String	Application name. Minimum: 3 Maximum: 128
duration	String	Deployment time.
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name. Minimum: 3 Maximum: 128
is_care	Boolean	Whether you have followed the application.
can_modify	Boolean	Whether you have the edit permission.
can_delete	Boolean	Whether you have the deletion permission.
can_view	Boolean	Whether you have the view permission.
can_execute	Boolean	Whether you have the deployment permission.
can_copy	Boolean	Whether you have the copy permission.
can_manage	Boolean	Whether you have permission to edit the application permission matrix.
can_create_env	Boolean	Whether you have the the permission to create an environment.
deploy_system	String	Deployment type. Options: deployTemplate, ansible, and shell.
create_user_id	String	User ID of the application creator.
create_tenant_id	String	Tenant ID of the application creator.
create_time	String	Creation time. Minimum: 3 Maximum: 128
update_time	String	Modification time. Minimum: 3 Maximum: 128
execution_time	String	Last deployment time. Minimum: 3 Maximum: 128
end_time	String	Deployment end time.
execution_state	String	Deployment status.
release_id	Integer	Deployment record sequence number.
executor_id	String	Deployer ID.
executor_nick_name	String	Deployer name.
arrange_infos	Array of TaskBaseResponseBody objects	Deployment task information.

**Table 5** TaskBaseResponseBody
Parameter	Type	Description
id	String	Deployment task ID.
state	String	Deployment task status.
deploy_system	String	Deployment task type.

Example Requests

This API is used to obtain an application list.

https://{endpoint}/v1/applications/list

{
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "page" : 1,
  "size" : 10
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : [ {
    "id" : "cb439d016d8641c8a44c177a121fad15",
    "name" : "Test",
    "duration" : "00:00:17",
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "Project 1.",
    "is_care" : false,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : false,
    "can_create_env" : false,
    "create_user_id" : "04ec4661a8df4359b50980a9c958c86d",
    "create_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d",
    "create_time" : "2023-07-05 20:34:40.0",
    "update_time" : "2023-08-02 14:20:30.0",
    "execution_time" : "2023-08-18 09:40:16",
    "end_time" : "2023-08-18 09:40:33",
    "execution_state" : "failed",
    "release_id" : 4,
    "executor_id" : "6baa7454109d47c192f22078fe6cda20",
    "executor_nick_name" : "Test Account",
    "arrange_infos" : [ {
      "id" : "e700f15965694253940502911220d76b",
      "state" : "failed",
      "deploy_system" : "deployTemplate"
    } ]
  } ],
  "total_num" : 1
}