文档首页/AI科学计算服务/API参考/API/应用管理/应用管理/获取应用详情 - ShowApp
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

获取应用详情 - ShowApp

功能介绍

获取应用详情。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

参数解释：

应用ID。

约束限制：

不涉及

取值范围：

仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及

eihealth_project_id

是

String

参数解释：

空间ID，您可以从获取空间ID中获取。

约束限制：

不涉及

取值范围：

仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及

project_id

是

String

参数解释：

项目ID，您可以从获取项目ID中获取。

约束限制：

不涉及

取值范围：

仅支持字母、数字、中划线和下划线，长度为[1-128]个字符。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制：

不涉及

取值范围：

长度为[1-32768]个字符。

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释：

应用ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

应用名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

version

String

参数解释：

应用版本。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

summary

String

参数解释：

应用短描述。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

String

参数解释：

应用描述。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

labels

Array of strings

参数解释：

应用标签。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

image

String

参数解释：

应用镜像。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

commands

Array of strings

参数解释：

应用命令。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

resources

ResourceDto object

参数解释：

应用申请资源。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

inputs

Array of AppInputParameterDto objects

参数解释：

应用的输入参数信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

outputs

Array of AppOutputParameterDto objects

参数解释：

应用的输出参数信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

String

参数解释：

创建应用时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_time

String

参数解释：

更新应用时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

user_name

String

参数解释：

创建应用的用户名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

source_project_name

String

参数解释：

源项目名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

source_resource_id

String

参数解释：

源资源ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

node_labels

Array of strings

参数解释：

节点标签。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

icon

String

参数解释：

图标base64编码。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

chargeable

Boolean

参数解释：

是否为计费的应用。

约束限制：

不涉及

取值范围：

  • true：是计费应用

  • false：不是计费应用

默认取值：

不涉及

表4 ResourceDto

参数

参数类型

描述

cpu_type

String

参数解释：

cpu架构类型。

约束限制：

不涉及

取值范围：

取值范围，支持X86|ARM。

默认取值：

X86。

cpu

String

参数解释：

cpu申请使用量。

约束限制：

不涉及

取值范围：

取值范围[0.1-128]，单位C，支持一位小数。对于应用，不填默认1C；对于流程和作业，不填默认使用前一级的配置，填值会覆盖更新。覆盖关系：作业->流程->应用。

默认取值：

不涉及

memory

String

参数解释：

内存申请使用量。

约束限制：

不涉及

取值范围：

取值范围[0.1-3072]，单位G，支持一位小数。对于应用，不填默认1G；对于流程和作业，不填默认使用前一级的配置，填值会覆盖更新。覆盖关系：作业->流程->应用。

默认取值：

不涉及

gpu_type

String

参数解释：

gpu架构类型。

约束限制：

不涉及

取值范围：

gpu架构类型，支持GPU|Snt9。对于流程和作业，不填默认使用前一级的配置，填值会覆盖更新。覆盖关系：作业->流程->应用。

默认取值：

不涉及

gpu

String

参数解释：

gpu申请使用量。

约束限制：

不涉及

取值范围：

取值范围[0-16]，仅支持整数。对于流程和作业，不填默认使用前一级的配置，填值会覆盖更新。覆盖关系：作业->流程->应用。

默认取值：

不涉及

表5 AppInputParameterDto

参数

参数类型

描述

name

String

参数解释：

参数名称，单个应用内唯一。

约束限制：

不涉及

取值范围：

长度为[1,32]，以小写字母开头，允许出现中划线（-）、小写字母和数字，且必须以小写字母或数字结尾。

默认取值：

不涉及

description

String

参数解释：

参数描述。

约束限制：

不涉及

取值范围：

长度[0-255]。

默认取值：

不涉及

required

Boolean

参数解释：

参数是否必须。

约束限制：

不涉及

取值范围：

  • true：参数是必须。

  • false：参数非必须。

默认取值：

false

concurrent

String

参数解释：

参数是否开启并发。当前支持vars_iter并发类型，不填表示未开启并发。

约束限制：

不涉及

取值范围：

取值范围[0-16]，仅支持vars_iter并发类型。

默认取值：

不涉及

type

String

参数解释：

参数类型。

约束限制：

不涉及

取值范围：

  • STRING：字符参数类型

  • FILE：文件参数类型

  • DIRECTORY：目录参数类型

  • ENUM：枚举参数类型

默认取值：

不涉及

pattern

String

参数解释：

提示用户参数填写的格式。

约束限制：

不涉及

取值范围：

取值范围[0-64]。对于STRING类型，匹配字符串内容，比如后缀约束.fastq；对于ENUM类型，可以提示一定要在param_enum列表范围内取值；对于FILE类型，约束文件后缀类型；对于DIRECTORY类型，提示目录下需要包含哪些文件。

默认取值：

不涉及

values

Array of strings

参数解释：

参数列表取值。

约束限制：

最多支持设置128个参数，每个参数取值范围[0,2048]。

取值范围：

不涉及

默认取值：

不涉及

enum

Array of strings

参数解释：

枚举参数的取值列表。

约束限制：

列表最大长度20，每一项字符串最长128。参数类型为ENUM时需要填此字段。

取值范围：

不涉及

默认取值：

不涉及

表6 AppOutputParameterDto

参数

参数类型

描述

name

String

参数解释：

参数名称，单个应用内唯一。

约束限制：

不涉及

取值范围：

长度为[1,32]，以小写字母开头，允许出现中划线（-）、小写字母和数字，且必须以小写字母或数字结尾。

默认取值：

不涉及

description

String

参数解释：

参数描述。

约束限制：

不涉及

取值范围：

长度[0-255]。

默认取值：

不涉及

required

Boolean

参数解释：

参数是否必须。

约束限制：

不涉及

取值范围：

  • true：参数是必须。

  • false：参数非必须。

默认取值：

false

type

String

参数解释：

参数类型。

约束限制：

不涉及

取值范围：

  • STRING：字符参数类型

  • FILE：文件参数类型

  • DIRECTORY：目录参数类型

  • ENUM：枚举参数类型

默认取值：

不涉及

pattern

String

参数解释：

提示用户参数填写的格式。

约束限制：

不涉及

取值范围：

取值范围[0-64]。对于STRING类型，匹配字符串内容，比如后缀约束.fastq；对于ENUM类型，可以提示一定要在param_enum列表范围内取值；对于FILE类型，约束文件后缀类型；对于DIRECTORY类型，提示目录下需要包含哪些文件。

默认取值：

不涉及

values

Array of strings

参数解释：

参数列表取值。

约束限制：

最多支持设置128个参数，每个参数取值范围[0,2048]。

取值范围：

不涉及

默认取值：

不涉及

enum

Array of strings

参数解释：

枚举参数的取值列表。

约束限制：

列表最大长度20，每一项字符串最长128。参数类型为ENUM时需要填此字段。

取值范围：

不涉及

默认取值：

不涉及

请求示例

查询应用详情。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}

响应示例

状态码：200

OK

{
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "name" : "demo-app",
  "version" : "1.0.0",
  "summary" : "summary",
  "description" : "description",
  "labels" : [ "labelA", "labelB" ],
  "image" : "gwj-test-01/busybox:latest",
  "commands" : [ "echo eihealth;" ],
  "resources" : {
    "cpu_type" : "X86",
    "cpu" : "1C",
    "memory" : "1G",
    "gpu_type" : "GPU",
    "gpu" : 0
  },
  "inputs" : [ {
    "name" : "dir-parameter",
    "description" : "parameter description",
    "required" : true,
    "concurrent" : "var_iter",
    "type" : "DIRECTORY",
    "pattern" : "*.fastq",
    "values" : [ "test-project:/300M_NA12878_clean_1.fastq" ]
  } ],
  "outputs" : [ {
    "name" : "dir-parameter",
    "description" : "parameter description",
    "required" : true,
    "type" : "DIRECTORY",
    "pattern" : "*.fastq",
    "values" : [ "test-project:/output-dir/" ]
  } ],
  "create_time" : "2021-01-30T02:34:36Z",
  "update_time" : "2021-01-30T02:53:26Z",
  "user_name" : "gwj-test-01",
  "source_project_name" : "null",
  "source_resource_id" : "null",
  "node_labels" : [ "health.node" ],
  "icon" : "data:image/png;base64,xxxxx"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：应用管理

相关文档