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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. Minimum: 32 Maximum: 32 |
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
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:
|
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number |
result |
Array of TaskInfo objects |
Returned result |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Deployment task ID |
name |
String |
Application name Minimum: 3 Maximum: 128 |
project_id |
String |
Project ID. For details, see Obtaining a Project ID. |
project_name |
String |
Project name Minimum: 3 Maximum: 128 |
deploy_system |
String |
Deployment type. Options: deployTemplate, ansible, and shell. |
create_time |
String |
Creation time Minimum: 3 Maximum: 128 |
update_time |
String |
Modification time Minimum: 3 Maximum: 128 |
state |
String |
Application status: Draft and Available. Enumeration values:
|
execution_time |
String |
Last deployment time Minimum: 3 Maximum: 128 |
description |
String |
Description Minimum: 0 Maximum: 1024 |
is_defaut_permission |
Boolean |
Whether to use the default permission matrix |
template_id |
String |
Template ID |
owner |
String |
Username of the application creator Minimum: 0 Maximum: 128 |
nick_name |
String |
Alias of the application creator Minimum: 0 Maximum: 128 |
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 Minimum: 0 Maximum: 128 |
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 |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Deployment task ID |
app_id |
String |
AOM application ID |
app_name |
String |
AOM application name |
comp_id |
String |
AOM application component ID |
comp_name |
String |
AOM application component name Minimum: 0 Maximum: 128 |
domain_id |
String |
Tenant ID |
region |
String |
Region information Minimum: 1 Maximum: 256 |
state |
String |
Whether the AOM application component takes effect. 0: The component is initialized. 1: The execution is successful and the component has taken effect. Minimum: 1 Maximum: 32 |
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 }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListDeployTasksSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ListDeployTasksRequest request = new ListDeployTasksRequest(); request.withPage(<page>); request.withSize(<size>); try { ListDeployTasksResponse response = client.listDeployTasks(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDeployTasksRequest() request.page = <page> request.size = <size> response = client.list_deploy_tasks(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListDeployTasksRequest{} request.Page = int32(<page>) request.Size = int32(<size>) response, err := client.ListDeployTasks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot