更新时间:2024-05-14 GMT+08:00
分享

查询应用

使用get命令查询应用的详细信息,该命令同时可用于获取应用模板。

命令结构

health get app ID [flags]
表1 参数说明

参数

简写

是否必选

说明

ID

  • 不选此参数时,列出当前所在项目的所有应用信息。
  • 指定app-id或app-name:version:srcproject,列出具体应用的信息,srcproject为源项目名称,可选。不指定srcproject时,默认为当前项目。例如GATK:4.0:projectname。

--sample

-s

获取应用模板,模板为yaml格式。

--downloadPath

-d

获取应用详情时,将内容下载到的指定文件夹路径(文件夹需要存在)。

--project

指定项目名。未填写则使用配置文件中的项目名。

--label

-l

根据label标签搜索应用。

命令示例

本节以Windows为例介绍eihealth-toolkit的使用过程,Linux和macOS环境使用方法基本相同,可参考。

  • 使用health get app -s命令获取模板,详细的模板介绍和使用请参见获取应用模板
  • 使用health get app命令查询指定应用信息。
    health  get app  550e8400-e29b-41d4-a716-446655440000
    
    health  get app  app-name:version
    
    get app successfully.
    指定app-id时返回结果:
    app:
      id: f165b7a6-5bc9-11eb-9fef-fa163ef9b34d
      name: lk-app-0121
      version: 1.0.0
      summary: dsfsdf
      description: fdsfsdf
      labels:
      - fdsfsdfsdf
      image: ei_eihealth_x00356764_02/modelarts-base-cpu-py3:custom-2.0.2
      commands:
      - echo lk-app-0121
      resources:
        cpu_type: X86
        cpu: 0.1C
        memory: 0.1G
        gpu_type: ""
        gpu: "0"
      inputs:
      - name: input1
        pattern: asfas
        type: DIRECTORY
        required: false
        description: dasdad
        enum: []
        values: []
      - name: input2
        pattern: ""
        type: FILE
        required: false
        description: ""
        enum: []
        values: []
      outputs:
      - name: output1
        pattern: dsfsdf
        type: DIRECTORY
        required: false
        description: sdfdsf
        values:
        - /sdsds
      license: ""
    
    health get app -s
    获取app.yaml模板,以yaml格式打印到控制台
    app:
      # 系统唯一标识,由系统随机分配,说明如下:
      # 1. 通过文件创建app时(UI\CMD),id必须为空,不允许指定
      # 2. 通过文件修改app时(CMD),id为空或与命令行中指定的保持一致
      # 3. 资产市场中发布的app,id为空
      id: ''                              # 可选
    
      # 业务唯一标识由name、version组成,项目内唯一
      # 1. 通过命令行修改app时,如命令行中指定app:version形式,必须和文件中的app:version保持一致
      name: 'test-app'                    # 必选 # app名称
      version: '1.0.0'                    # 必选 # app版本,app名称+app版本在一个项目内需要保持唯一且不允许修改
      summary: 'summary'                  # 可选 # 短描述
    
      description: 'description'          # 可选 # 完整描述文本
    
      labels:                             # 可选 # 标签
      - labelA
      - labelB
      image: 'xxxx'                       # 必选 # 镜像地址
      commands:                           # 必选 # 命令列表
      - xxx
      resources:                          # 必选 # 运行环境要求
        cpu_type: X86                     # 必选 # 'CPU架构,如X86、ARM'
        cpu: 2C                           # 可选 # 'CPU数量'
        memory: 4G                        # 可选 # '内存大小'
        gpu_type:                         # 可选 # 'GPU类型'
        gpu:                              # 可选 # 'GPU数量'
      inputs:                             # 可选 # 输入参数列表
      - name: 'input_name1'               # 参数名称
        type: FILE                        # 参数类型 # STRING|FILE|DIRECTORY|ENUM
        pattern: '*.fastq'                # 参数模式,界面展示,不做强校验
        required: true                    # 是否必填
        description: ''                   # 参数描述
        enum:                             # 枚举类型时,枚举值列表
        - xxx
        values:                           # 参数值,非数组类型仅允许填写单个值
        - xxx
      outputs:                            # 可选 # 输出参数列表,app创建、修改时指定
      - name: 'output_name1'
        type: FILE                        # FILE和DIRECTORY两种类型,指定输出的相对路径
        pattern: '*'                      # 参数模式,界面展示,不做强校验
        required: true                    # 是否必填
        description: ''                   # 描述
        values:
        - xxx                             #当type为FILE or DIRECTORY时,values中指定的路径为子路径,实际路径为${workflow:output_dir}/xxx
      license: xxx                        #app的许可证
    
    health get app -s > app.yaml
    将app yaml模板文件存储到当前所在路径的app.yaml文件中
    
    health get app 91a3bdf6-c445-11ec-a9f3-fa163e507c84 -d ./a
    download app detail successfully!
    
    # 根据label标签搜索应用
    health get app -l  labelA
    id                                        name                version    label                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   source_eihealth_project_name  user_name                      create_time             update_time
    913b4116-aaa2-11ee-a057-fa163ef319da      cli-demo-app        2.0.0      labelA,labelB                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           test-new-project              wwx-test-admin                 2024-01-04 09:42:49     2024-01-04 09:42:49

相关文档