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 |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: 32 characters, including letters and digits. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
page |
Yes |
Integer |
Definition: Page number, indicating that the query starts from this page. Constraints: N/A. Value range: 1–99999 Default value: N/A. |
size |
Yes |
Integer |
Definition: Number of records displayed on each page. Constraints: N/A. Value range: 1–100 Default value: N/A. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Definition: Type (or format) of the message body. Constraints: N/A. Value range: N/A. Default value: N/A. |
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Definition: Total number of deployment tasks. Value range: N/A. |
result |
Array of TaskInfo objects |
Definition: Deployment task list. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Definition: Deployment task ID. Value range: 32 characters, including letters and digits. |
name |
String |
Definition: Application name. Value range: 3 to 128 characters, including letters, digits, hyphens (-), and underscores (_). |
project_id |
String |
Definition: Project ID. Value range: 32 characters, including letters and digits. |
project_name |
String |
Definition: Project name. Value range: 3 to 128 characters. |
deploy_system |
String |
Definition: Deployment type mode. Value range:
|
create_time |
String |
Definition: Creation time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A. |
update_time |
String |
Definition: Modification time. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A. |
state |
String |
Definition: Application status. Value range:
|
execution_time |
String |
Definition: Last deployment time of the application. Format: yyyy-MM-dd HH:mm:ss. Value range: N/A. |
description |
String |
Definition: Description. Value range: Max. 1,024 characters. |
is_defaut_permission |
Boolean |
Definition: Whether you are the default role of the project management. Value range:
|
template_id |
String |
Definition: Template ID. Value range: 32 characters, including letters and digits. |
owner |
String |
Definition: Username of the application creator. Value range: Max. 128 characters. |
nick_name |
String |
Definition: Nickname of the application creator. Value range: Max. 128 characters. |
owner_id |
String |
Definition: Application creator ID. Value range: 32 characters, including letters and digits. |
tenant_id |
String |
Definition: Tenant ID of the application creator. Value range: 32 characters, including letters and digits. |
tenant_name |
String |
Definition: Tenant name of the application creator. Value range: Max. 128 characters. |
slave_cluster_id |
String |
Definition: ID of slave cluster. Value range: 32 characters, including letters and digits. |
is_care |
Boolean |
Definition: Whether you have favorited the application. Value range:
|
can_modify |
Boolean |
Definition: Whether you have the edit permission. Value range:
|
can_delete |
Boolean |
Definition: Whether you have the delete permission. Value range:
|
can_view |
Boolean |
Definition: Whether you have the view permission. Value range:
|
can_execute |
Boolean |
Definition: Whether you have the deployment permission. Value range:
|
can_copy |
Boolean |
Definition: Whether you have the copy permission. Value range:
|
can_manage |
Boolean |
Definition: Whether you have permission to edit the application permission matrix. Value range:
|
can_disable |
Boolean |
Definition: Whether you have permission to disable applications. Value range:
|
app_component_list |
Array of AppComponentDao objects |
Definition: Application component list. |
role_id |
Integer |
Definition: Project management role ID. Value range: N/A. |
id |
String |
Definition: Deployment task ID. Value range: 32 characters, including letters and digits. |
release_id |
Integer |
Definition: Deployment record sequence number. Value range: N/A. |
app_id |
String |
Definition: Deployment application ID. Value range: 32 characters, including letters and digits. |
is_disable |
Boolean |
Definition: Whether the application is disabled. Value range:
|
duration |
String |
Definition: Deployment duration. Format: HH:mm:ss. Value range: N/A. |
execution_state |
String |
Definition: Last execution status of the application. Value range:
|
executor_id |
String |
Definition: Deployer ID. Value range: N/A. |
executor_nick_name |
String |
Definition: Deployer nickname. Value range: N/A. |
steps |
Map<String,Step> |
Definition: Deployment action. |
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:
|
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 |
Definition: Whether to enable an action. Value range:
|
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 |
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.withProjectId("{project_id}"); 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 |
# 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.project_id = "{project_id}" 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 |
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.ProjectId = "{project_id}" 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