获取应用列表
功能介绍
查询项目下应用列表。该接口于2024年09月30日后不再维护,推荐使用新版获取应用列表(ListAllApp)接口。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/tasks/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id,获取方式请参见获取项目id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page |
是 |
Integer |
分页页码, 表示从此页开始查询, page大于等于1 |
size |
是 |
Integer |
每页显示的条目数量,size小于等于100 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
总数 |
result |
Array of TaskInfo objects |
返回结果 |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
部署任务id |
name |
String |
应用名称 |
project_id |
String |
项目id,获取方式请参见获取项目id。 |
project_name |
String |
项目名称 |
deploy_system |
String |
部署类型模式,包括deployTemplate、ansible、shell |
create_time |
String |
创建时间 |
update_time |
String |
修改时间 |
state |
String |
应用状态,Draft表示草稿状态,Available表示可用状态 |
execution_time |
String |
最后一次部署时间 |
description |
String |
描述 |
is_defaut_permission |
Boolean |
是否使用默认权限矩阵 |
template_id |
String |
模板id |
owner |
String |
应用创建者用户名 |
nick_name |
String |
应用创建者昵称 |
owner_id |
String |
应用创建者用户id |
tenant_id |
String |
应用创建者租户id |
tenant_name |
String |
应用创建者租户名 |
slave_cluster_id |
String |
slave集群id,默认为null时使用默认slave集群,用户自定义slave时为slave集群id |
is_care |
Boolean |
当前用户是否已收藏 |
can_modify |
Boolean |
是否有编辑权限 |
can_delete |
Boolean |
是否有删除的权限 |
can_view |
Boolean |
是否有查看权限 |
can_execute |
Boolean |
是否有部署权限 |
can_copy |
Boolean |
是否有复制权限 |
can_manage |
Boolean |
是否有编辑应用权限矩阵的权限 |
can_disable |
Boolean |
是否有禁用应用的权限 |
app_component_list |
Array of AppComponentDao objects |
应用和AOM应用组件对应关系 |
role_id |
Integer |
角色id,0:应用创建者,-1:项目创建者,3:项目经理,4:开发人员,5:测试经理,6:测试人员,7:参与者,8:浏览者 |
id |
String |
部署任务id |
release_id |
Integer |
部署记录序列号 |
is_disable |
Boolean |
当前应用是否被禁用 |
duration |
String |
部署时间 |
execution_state |
String |
部署状态 |
executor_id |
String |
部署者id |
executor_nick_name |
String |
部署者名称 |
steps |
Map<String,Step> |
部署步骤 |
参数 |
参数类型 |
描述 |
---|---|---|
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应用组件是否生效。 取值范围:
|
请求示例
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
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) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。