更新时间:2025-12-25 GMT+08:00

获取应用详情 (推荐)

功能介绍

根据应用id获取应用详情。

调用方法

请参见如何调用API

URI

GET /v1/applications/{app_id}/info

表1 路径参数

参数

是否必选

参数类型

描述

app_id

String

参数解释

应用id。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及。

取值范围

字符串,长度不超过20000个字符。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

AppDetailInfo object

参数解释

应用详情信息。

status

String

参数解释

请求成功失败状态。

取值范围

  • success: 成功

  • error: 失败

表4 AppDetailInfo

参数

参数类型

描述

id

String

参数解释

应用id。

取值范围

由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

应用名称。

取值范围

由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。

region

String

参数解释

应用所属区域。

取值范围

不涉及。

description

String

参数解释

描述。

取值范围

长度为[0,1024]个字符。

is_disable

Boolean

参数解释

当前应用是否被禁用。

取值范围

  • true: 被禁用

  • false: 未被禁用

create_type

String

参数解释

创建方式。

取值范围

  • template: 自由编排应用

project_id

String

参数解释

项目id,获取方式请参见获取项目id

取值范围

由英文字母、数字组成,且长度为32个字符。

project_name

String

参数解释

项目名称。

取值范围

长度为[3,128]个字符。

slave_cluster_id

String

参数解释

slave集群id,默认为空,为空时使用默认资源池。

取值范围

只能由英文字母、数字组成,且长度为32个字符或者为null。

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_create_env

Boolean

参数解释

当前用户是否有创建环境的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_disable

Boolean

参数解释

当前用户是否有禁用应用的权限。

取值范围

  • true: 有权限

  • false: 无权限

owner_tenant_id

String

参数解释

应用所属者租户id。

取值范围

由英文字母、数字组成,且长度为[1,32]个字符。

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。

取值范围

不涉及。

permission_level

String

参数解释

应用鉴权级别。

取值范围

  • project: 项目级鉴权

  • instance: 实例级鉴权

arrange_infos

Array of TaskV2Info objects

参数解释

部署任务信息。

表5 TaskV2Info

参数

参数类型

描述

id

String

参数解释

部署任务id。

取值范围

由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

部署任务名称。

取值范围

由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。

state

String

参数解释

部署任务状态。

取值范围

  • Available: 可执行状态

  • Draft: 草稿状态

description

String

参数解释

描述。

取值范围

长度为[0,1024]个字符。

owner

String

参数解释

部署任务所属人。

取值范围

不涉及。

steps

Map<String,Step>

参数解释

部署步骤。

project_id

String

参数解释

项目id,获取方式请参见获取项目id

取值范围

由英文字母、数字组成,且长度为32个字符。

project_name

String

参数解释

项目名称。

取值范围

长度为[3,128]个字符。

deploy_system

String

参数解释

部署类型模式。

取值范围

  • deployTemplate: 部署模板

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。

取值范围

不涉及。

role_id

Integer

参数解释

项目管理角色id。

取值范围

不涉及。

is_defaut_permission

Boolean

参数解释

当前用户是否为项目管理默认角色。

取值范围

  • true: 是

  • false: 否

template_id

String

参数解释

模板id。

取值范围

由英文字母、数字组成,且长度为[1,32]个字符。

nick_name

String

参数解释

应用创建者昵称。

取值范围

字符串,长度为[1-30]个字符。

owner_id

String

参数解释

应用创建者用户id。

取值范围

由英文字母、数字组成,且长度为[1,32]个字符。

tenant_id

String

参数解释

应用创建者租户id。

取值范围

由英文字母、数字组成,且长度为[1,32]个字符。

tenant_name

String

参数解释

应用创建者租户名。

取值范围

长度为[0,128]个字符。

slave_cluster_id

String

参数解释

slave集群id,默认为空,为空时使用默认资源池。

取值范围

只能由英文字母、数字组成,且长度为32个字符或者为null。

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_create_env

Boolean

参数解释

当前用户是否有创建环境的权限。

取值范围

  • true: 有权限

  • false: 无权限

can_disable

Boolean

参数解释

当前用户是否有禁用应用的权限。

取值范围

  • true: 有权限

  • false: 无权限

app_component_list

Array of AppComponentDao objects

参数解释

应用组件列表。

release_id

Integer

参数解释

部署记录序列号。

取值范围

不涉及。

app_id

String

参数解释

部署任务所属应用id。

取值范围

由英文字母、数字组成,且长度为32个字符。

is_disable

Boolean

参数解释

当前应用是否被禁用。

取值范围

  • true: 被禁用

  • false: 未被禁用

表6 Step

参数

参数类型

描述

id

String

参数解释

步骤id。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

name

String

参数解释

步骤名称。

取值范围

只能由汉字、英文字母、空格、数字或特殊字符-_,;:./()()符号且不能以空格开头或结尾,最大长度不超过128字符。

params

Map<String,String>

参数解释

步骤参数。

取值范围

不涉及

enable

Boolean

参数解释

步骤是否开启。

取值范围

  • true: 步骤已启用

  • false: 步骤未启用

表7 AppComponentDao

参数

参数类型

描述

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: 执行成功,已生效

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

https://{endpoint}/v1/applications/d2dc947ec2424d8789bb3984bb3adf45/info

响应示例

状态码:200

OK 请求响应成功

{
  "result" : {
    "id" : "d9e0532073e2475dbed64b22e64f3b26",
    "name" : "deployenv202308211530723",
    "region" : "example.com",
    "description" : "for_test",
    "is_disable" : true,
    "create_type" : "template",
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "测试项目",
    "slave_cluster_id" : null,
    "is_care" : false,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : true,
    "can_create_env" : true,
    "can_disable" : true,
    "owner_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d",
    "create_user_id" : "6baa7454109d47c192f22078fe6cda20",
    "create_tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
    "create_time" : "2023-08-21 15:30:51.0",
    "update_time" : "2023-08-21 15:30:51.0",
    "permission_level" : "instance",
    "arrange_infos" : [ {
      "id" : "685a6f3b80264e7d96f2ba308f8414e5",
      "name" : "deployenv202308211530723",
      "state" : "Draft",
      "description" : "for_test",
      "owner" : "devcloud_devcloud_l00490255_01",
      "steps" : {
        "step1" : {
          "id" : null,
          "name" : "安装GO语言",
          "params" : { },
          "enable" : true
        },
        "step2" : {
          "id" : null,
          "name" : "下载软件包",
          "params" : { },
          "enable" : true
        },
        "step3" : {
          "id" : null,
          "name" : "停止Go服务",
          "params" : { },
          "enable" : true
        },
        "step4" : {
          "id" : null,
          "name" : "启动Go服务",
          "params" : { },
          "enable" : true
        },
        "step5" : {
          "id" : null,
          "name" : "健康测试",
          "params" : { },
          "enable" : true
        }
      },
      "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
      "project_name" : "测试项目",
      "deploy_system" : "deployTemplate",
      "create_time" : "2023-08-21 15:30:51",
      "update_time" : "2023-08-21 15:30:51",
      "role_id" : 0,
      "is_defaut_permission" : false,
      "template_id" : "681bd91f9d6e42cdb4cb84d6718de9fe",
      "nick_name" : "用户昵称",
      "owner_id" : "6baa7454109d47c192f22078fe6cda20",
      "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
      "tenant_name" : "devcloud_devcloud_l00490255_01",
      "slave_cluster_id" : null,
      "is_care" : false,
      "can_modify" : true,
      "can_delete" : true,
      "can_view" : true,
      "can_execute" : true,
      "can_copy" : true,
      "can_manage" : true,
      "can_create_env" : false,
      "can_disable" : false,
      "app_component_list" : [ ],
      "release_id" : 0,
      "app_id" : "d9e0532073e2475dbed64b22e64f3b26",
      "is_disable" : true
    } ]
  },
  "status" : "success"
}

状态码: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

错误码

请参见错误码