获取应用列表 (推荐)
功能介绍
查询项目下应用列表。
调用方法
请参见如何调用API。
URI
POST /v1/applications/list
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| page | 是 | Integer | 参数解释: 分页页码,表示从此页开始查询。 约束限制: 不涉及。 取值范围: 1-99999 默认取值: 不涉及。 |
| size | 是 | Integer | 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 不涉及。 |
| sort_name | 否 | String | 参数解释: 排序字段的名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| sort_by | 否 | String | 参数解释: 排序顺序。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| states | 否 | Array of strings | 参数解释: 应用状态列表。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
| group_id | 否 | String | 参数解释: 应用的分组id,传入no_grouped为查询未分组的应用。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符 或者 no_grouped。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Integer | 参数解释: 应用总数。 取值范围: 不涉及。 |
| result | Array of AppExecutionInfo objects | 参数解释: 应用列表数组。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 应用id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
| name | String | 参数解释: 应用名称。 取值范围: 由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。 |
| duration | String | 参数解释: 最后一次部署时长,格式为:HH:mm:ss。 取值范围: 不涉及。 |
| is_disable | Boolean | 参数解释: 当前应用是否被禁用。 取值范围:
|
| project_id | String | 参数解释: 项目id,获取方式请参见获取项目id。。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
| 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 | 参数解释: 部署类型模式。 取值范围:
|
| create_user_id | String | 参数解释: 应用创建者用户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 |
| create_tenant_id | String | 参数解释: 应用创建者租户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 |
| create_time | String | 参数解释: 创建时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 |
| update_time | String | 参数解释: 修改时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 |
| execution_time | String | 参数解释: 最后一次部署时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 |
| end_time | String | 参数解释: 最后一次部署结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 |
| execution_state | String | 参数解释: 部署状态。 取值范围:
|
| release_id | Integer | 参数解释: 部署记录序列号。 取值范围: 不涉及。 |
| executor_id | String | 参数解释: 最后一次部署者id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 |
| executor_nick_name | String | 参数解释: 最后一次部署者昵称。 取值范围: 字符串,长度为[1-30]个字符。 |
| arrange_infos | Array of TaskBaseResponseBody objects | 参数解释: 部署任务信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
| state | String | 参数解释: 部署任务状态。 取值范围:
|
| deploy_system | String | 参数解释: 部署类型模式。 取值范围:
|
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | 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" : "Draft",
"deploy_system" : "deployTemplate"
} ]
} ],
"total_num" : 1
} 状态码:400
Bad Request
{
"error_code" : "Deploy.00015002",
"error_msg" : "Invalid request parameter."
} 状态码:403
Forbidden
{
"error_code" : "Deploy.00011154",
"error_msg" : "You do not have permissions to perform this operation."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK 请求响应成功 |
| 400 | Bad Request |
| 403 | Forbidden |
错误码
请参见错误码。