Obtaining an Application List (Recommended)
Function
This API is used to query an application list in a project.
Calling Method
For details, see Calling APIs.
URI
POST /v1/applications/list
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see [Obtaining a Project ID] (CloudDeploy_api_0014.xml). Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A |
page |
Yes |
Integer |
Parameter description: Page number, which means the query starts from this page. Constraints: N/A Value range: 1-99,999 Default value: N/A |
size |
Yes |
Integer |
Parameter description: Number of items displayed on each page. Constraints: N/A Value range: 1-100 Default value: N/A |
sort_name |
No |
String |
Parameter description: Sort field name. Constraints: N/A Value range:
Default value: N/A |
sort_by |
No |
String |
Parameter description: Sorting sequence. Constraints: N/A Value range:
Default value: N/A |
states |
No |
Array of strings |
Parameter description: Application status list. Constraints: N/A Value range:
Default value: N/A |
group_id |
No |
String |
Parameter description: Application group ID. Enter no_grouped to query ungrouped applications. Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed or the no_grouped value is transferred. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Parameter description: Total number of applications. Value range: N/A |
result |
Array of AppExecutionInfo objects |
Parameter description: Application list array. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Parameter description: Application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
name |
String |
Parameter description: Application name. Value range: The value consists of 3-128 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
duration |
String |
Parameter description: Deployment time. Value range: N/A |
is_disable |
Boolean |
Parameter description: Whether the application is disabled. Value range:
|
project_id |
String |
Parameter description: Project ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
project_name |
String |
Parameter description: Project name. Value range: The value consists of 3 to 128 characters. |
is_care |
Boolean |
Parameter description: Whether a user has favorited the application. Value range:
|
can_modify |
Boolean |
Parameter description: Whether a user has the edit permission. Value range:
|
can_delete |
Boolean |
Parameter description: Whether a user has the delete permission. Value range:
|
can_view |
Boolean |
Parameter description: Whether a user has the view permission. Value range:
|
can_execute |
Boolean |
Parameter description: Whether a user has the deploy permission. Value range:
|
can_copy |
Boolean |
Parameter description: Whether a user has the clone permission. Value range:
|
can_manage |
Boolean |
Parameter description: Whether a user has permission to edit the application permission matrix. Value range:
|
can_create_env |
Boolean |
Parameter description: Whether a user has the permission to create environments. Value range:
|
can_disable |
Boolean |
Parameter description: Whether a user has permission to disable applications. Value range:
|
deploy_system |
String |
Parameter description: Deployment mode. Value range:
|
create_user_id |
String |
Parameter description: ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed. |
create_tenant_id |
String |
Parameter description: Tenant ID of the application creator. Value range: The value consists of 1-32 characters. Letters and digits are allowed. |
create_time |
String |
Parameter description: Creation time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
update_time |
String |
Parameter description: Modification time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
execution_time |
String |
Parameter description: Last deployment time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
end_time |
String |
Parameter description: Deployment end time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27. Value range: N/A |
execution_state |
String |
Parameter description: Deployment status. Value range: N/A |
release_id |
Integer |
Parameter description: Deployment record sequence number. Value range: N/A |
executor_id |
String |
Parameter description: Deployer ID. Value range: The value consists of 1-32 characters. Letters and digits are allowed. |
executor_nick_name |
String |
Parameter description: Deployer nickname. Value range: N/A |
arrange_infos |
Array of TaskBaseResponseBody objects |
Parameter description: Deployment task information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
state |
String |
Parameter description: Deployment task status. Value range:
|
deploy_system |
String |
Parameter description: Deployment mode. Value range:
|
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", "is_disable" : true, "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, "can_disable" : 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 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.