# 获取应用列表 - ListDeployTasks #### 功能介绍 查询项目下应用列表。该接口于2024年09月30日后不再维护，推荐使用新版获取应用列表（ListAllApp）接口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_1001.html)。 #### URI GET /v2/{project_id}/tasks/list 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目id，获取方式请参见[获取项目id](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_0012.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page | 是 | Integer | **参数解释**： 分页页码，表示从此页开始查询。 **约束限制**： 不涉及。 **取值范围**： 1-99999 **默认取值**： 不涉及。 | | size | 是 | Integer | **参数解释**： 每页显示的条目数量。 **约束限制**： 不涉及。 **取值范围**： 1-100 **默认取值**： 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释**： 消息体的类型（格式）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： application/json。 | | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 字符串，长度不超过20000个字符。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释**： 部署任务总数。 **取值范围**： 不涉及。 | | result | Array of [TaskInfo] objects | **参数解释**： 部署任务列表。 **取值范围**： 不涉及。 | 表5TaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释**： 部署任务id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | name | String | **参数解释**： 应用名称。 **取值范围**： 由中文、英文字母、数字、-、_组成，且长度为3\~128个字符。 | | project_id | String | **参数解释**： 项目id，获取方式请参见[获取项目id](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_0012.html)。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | project_name | String | **参数解释**： 项目名称。 **取值范围**： 长度为3\~128个字符。 | | deploy_system | String | **参数解释**： 部署类型模式。 **取值范围**： - deployTemplate: 部署模板类型。 | | create_time | String | **参数解释**： 创建时间。时间格式：yyyy-MM-dd HH:mm:ss。 **取值范围**： 不涉及。 | | update_time | String | **参数解释**： 修改时间。时间格式：yyyy-MM-dd HH:mm:ss。 **取值范围**： 不涉及。 | | state | String | **参数解释**： 应用状态。 **取值范围**： - Draft: 表示应用为草稿状态 - Available: 表示应用为可用状态 | | execution_time | String | **参数解释**： 应用最后一次部署时间。时间格式：yyyy-MM-dd HH:mm:ss。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 描述。 **取值范围**： 长度为0\~1024个字符。 | | is_defaut_permission | Boolean | **参数解释**： 当前用户是否为项目管理默认角色。 **取值范围**： - true: 是 - false: 否 | | template_id | String | **参数解释**： 模板id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | owner | String | **参数解释**： 应用创建者用户名。 **取值范围**： 长度最长为128个字符。 | | nick_name | String | **参数解释**： 应用创建者昵称。 **取值范围**： 字符串，长度为\[1-30\]个字符。 | | owner_id | String | **参数解释**： 应用创建者用户id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | tenant_id | String | **参数解释**： 应用创建者租户id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | tenant_name | String | **参数解释**： 应用创建者租户名。 **取值范围**： 长度最长为128个字符。 | | slave_cluster_id | String | **参数解释**： slave集群id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | is_care | Boolean | **参数解释**： 当前用户是否已收藏本应用。 **取值范围**： - true: 已收藏 - false: 未收藏 | | can_modify | Boolean | **参数解释**： 当前用户是否有编辑权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_delete | Boolean | **参数解释**： 当前用户是否有删除的权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_view | Boolean | **参数解释**： 当前用户是否有查看权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_execute | Boolean | **参数解释**： 当前用户是否有部署权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_copy | Boolean | **参数解释**： 当前用户是否有复制权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_manage | Boolean | **参数解释**： 当前用户是否有编辑应用权限矩阵的权限。 **取值范围**： - true: 有权限 - false: 无权限 | | can_disable | Boolean | **参数解释**： 当前用户是否有禁用应用的权限。 **取值范围**： - true: 有权限 - false: 无权限 | | app_component_list | Array of [AppComponentDao] objects | **参数解释**： 应用组件列表。 | | role_id | Integer | **参数解释**： 项目管理角色id。 **取值范围**： 不涉及。 | | id | String | **参数解释**： 部署任务id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | release_id | Integer | **参数解释**： 部署记录序列号。 **取值范围**： 不涉及。 | | app_id | String | **参数解释**： 部署应用id。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | is_disable | Boolean | **参数解释**： 当前应用是否被禁用。 **取值范围**： - true: 被禁用 - false: 未被禁用 | | duration | String | **参数解释**： 部署用时，格式为：HH:mm:ss。 **取值范围**： 不涉及。 | | execution_state | String | **参数解释**： 应用最后一次执行状态。 **取值范围**： - abort: 部署中止 - failed: 部署失败 - not_started: 取消执行 - pending: 排队中 - running: 正在部署 - succeeded: 部署成功 | | executor_id | String | **参数解释**： 部署者id。 **取值范围**： 不涉及。 | | executor_nick_name | String | **参数解释**： 部署者昵称。 **取值范围**： 字符串，长度为\[1-30\]个字符。 | | steps | Map\ | **参数解释**： 部署步骤。 | 表6AppComponentDao | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | **参数解释**： 部署任务ID。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | app_id | String | **参数解释**： AOM应用ID。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | app_name | String | **参数解释**： AOM应用名称。 **取值范围**： 由英文字母、数字组成。 | | comp_id | String | **参数解释**： AOM应用组件ID。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | comp_name | String | **参数解释**： AOM应用组件名称。 **取值范围**： 长度为\[0,128\]个字符。 | | domain_id | String | **参数解释**： 租户ID。 **取值范围**： 由英文字母、数字组成，且长度为32个字符。 | | region | String | **参数解释**： 局点信息。 **取值范围**： 长度为\[1,256\]个字符。 | | state | String | **参数解释**： AOM应用组件是否生效。 **取值范围**： - 0: 初始化 - 1: 执行成功，已生效 | 表7Step | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 步骤id。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 | | name | String | **参数解释**： 步骤名称。 **取值范围**： 只能由汉字、英文字母、空格、数字或特殊字符-_,;:./()（）符号且不能以空格开头或结尾，最大长度不超过128字符。 | | params | Map\ | **参数解释**： 步骤参数。 **取值范围**： 不涉及 | | enable | Boolean | **参数解释**： 步骤是否开启。 **取值范围**： - true: 步骤已启用 - false: 步骤未启用 | #### 请求示例 ``` https://endpoint/v2/332f53cbabc44863a46ce6b4f82a9fe7/tasks/list?page=1&size=2 ``` #### 响应示例 **状态码：200** OK 请求响应成功 ``` { "result" : [ { "id" : "2c82ffe8d00d4968a4e5f7a36d87ae17", "name" : "消息通知", "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" : "AB边账号", "nick_name" : "AB边账号", "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代码示例 SDK代码示例如下。 #### Java ``` 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("")) .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 ``` # 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("")) \ .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 ``` 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("")). 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) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsDeploy/sdk?api=ListDeployTasks)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 请求响应成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-deployman/ErrorCode.html)。