文档首页> 部署 CodeArts Deploy> API参考> API> 应用管理> 获取应用列表 （推荐）
更新时间：2024-04-10 GMT+08:00
查看PDF
分享

获取应用列表 （推荐）

功能介绍

查询项目下应用列表

调用方法

请参见如何调用API。

URI

POST /v1/applications/list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），下方类型可任选其一使用： application/json;charset=utf-8 application/json

缺省值：application/json;charset=utf-8

枚举值：

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

最小长度：0

最大长度：20000
表2 请求Body参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：32

最大长度：32

page

是

Integer

分页页码，表示从此页开始查询，page大于等于1

size

是

Integer

每页显示的条目数量，size小于等于100

sort_name

否

String

排序字段的名称，当前仅支持name和startTime

枚举值：

  • name

  • startTime

sort_by

否

String

排序顺序，正序（ASC）或者逆序（DESC)

states

否

Array of strings

应用状态列表，支持查询以下状态： abort: 部署中止 failed: 部署失败 not_started: 取消执行 pending: 排队中 running: 正在部署 succeeded: 部署成功 timeout: 部署超时 not_executed: 未执行

枚举值：

  • abort

  • failed

  • not_started

  • pending

  • running

  • succeeded

  • timeout

  • not_executed

group_id

否

String

应用的分组id，传入no_grouped为查询未分组的应用

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

result

Array of AppExecutionInfo objects

应用列表数组
表4 AppExecutionInfo

参数

参数类型

描述

id

String

应用id

name

String

应用名称

最小长度：3

最大长度：128

duration

String

部署时间

is_disable

Boolean

当前应用是否被禁用

project_id

String

项目ID，获取方式请参见获取项目ID。

project_name

String

项目名称

最小长度：3

最大长度：128

is_care

Boolean

当前用户是否已收藏

can_modify

Boolean

是否有编辑权限

can_delete

Boolean

是否有删除的权限

can_view

Boolean

是否有查看权限

can_execute

Boolean

是否有部署权限

can_copy

Boolean

是否有复制权限

can_manage

Boolean

是否有编辑应用权限矩阵的权限

can_create_env

Boolean

是否有创建环境的权限

can_disable

Boolean

是否有禁用应用的权限

deploy_system

String

部署类型模式，包括deployTemplate、ansible、shell

create_user_id

String

应用创建者用户ID

create_tenant_id

String

应用创建者租户ID

create_time

String

创建时间

最小长度：3

最大长度：128

update_time

String

修改时间

最小长度：3

最大长度：128

execution_time

String

最后一次部署时间

最小长度：3

最大长度：128

end_time

String

部署结束时间

execution_state

String

部署状态

release_id

Integer

部署记录序列号

executor_id

String

部署者id

executor_nick_name

String

部署者名称

arrange_infos

Array of TaskBaseResponseBody objects

部署任务信息
表5 TaskBaseResponseBody

参数

参数类型

描述

id

String

部署任务id

state

String

部署任务状态

deploy_system

String

部署任务类型

请求示例

获取应用列表

https://{endpoint}/v1/applications/list

{
  "project_id" : "6039d4480efc4dddb178abff98719913",
  "page" : 1,
  "size" : 10
}

响应示例

状态码： 200

OK 请求响应成功

{
  "result" : [ {
    "id" : "cb439d016d8641c8a44c177a121fad15",
    "name" : "Test",
    "duration" : "00:00:17",
    "is_disable" : true,
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "项目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" : "测试账号",
    "arrange_infos" : [ {
      "id" : "e700f15965694253940502911220d76b",
      "state" : "failed",
      "deploy_system" : "deployTemplate"
    } ]
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

OK 请求响应成功

错误码

请参见错误码。

父主题： 应用管理
分享：

    相关文档

    相关产品