文档

GetApp - 查询应用详情

更新时间:

查询工作空间下特定应用详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
easygene:GetAppRead
  • App
    acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}

请求参数

名称类型必填描述示例值
Workspacestring

工作空间名称

TestWorkspace
AppNamestring

应用名称

TestApp
Revisionstring

应用版本号

0
RevisionTagstring

应用版本唯一标签

TestTag

返回参数

名称类型描述示例值
object

应用详情

WorkflowNamestring

工作流名称

MyTestWorkflow
AppNamestring

应用名称

MyTestApp
CreateTimestring

创建时间

2021-06-16T15:09:14.378297+08:00
Definitionstring

应用定义

WDL content
Descriptionstring

应用简要描述

This is a test app
Documentationstring

应用详细文档

example documentation content
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
Inputsobject []

应用输入

TaskNamestring

任务名称

TestTaskName
VariableNamestring

变量名称

TestVariableName
VariableTypestring

变量类型

TestVariableType
VariableValuestring

变量值

TestVariableValue
Requiredboolean

是否必须

true
Helpstring

帮助

help information
StepOrderlong

步骤顺序

1
Labelsobject

应用标签

string

标签

test
Languagestring

应用描述语言

WDL
LanguageVersionstring

应用描述语言版本

1.0
LastModifiedTimestring

应用最后修改时间

2021-06-16T15:09:14.378297+08:00
Outputsobject []

应用的输出参数

TaskNamestring

任务名称

TestTaskName
VariableNamestring

参数名称

TestVariableName
VariableTypestring

参数类型

Int
VariableValuestring

参数值

ExampleValue
Requiredboolean

是否必须

true
Helpstring

帮助信息

Example help information
StepOrderlong

步骤编号

1
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
Revisionstring

应用版本号

1
RevisionTagstring

应用版本唯一标签

TestTag
RevisionCommentstring

应用当前版本修改

Example revision comment
Revisionsobject []

应用的所有版本号

CreateTimestring

创建时间

2021-06-16T15:09:14.378297+08:00
Revisionstring

版本号

1
RevisionCommentstring

应用当前版本修改

Example revision comment
RevisionTagstring

应用版本唯一标签

ProduceVersion
Scopestring

应用可见范围

Public
URLstring

应用 URL

Example url
Workspacestring

工作空间名称

TestWorkspace
Sourcestring

应用来源

EasyGene
AppTypestring

实体类型

App
Dependenciesobject []

依赖应用

Pathstring

依赖路径

./task/echo.wdl
Contentstring

wdl 内容

task echo { String txt_out = "default_txt_out" String dd_out = "default_dd_out" command { echo Hello > ${txt_out} /bin/bash -c "dd if=/dev/zero of=${dd_out} bs=1M count=15" echo "This is a test std out." } runtime { cpu: "2" memory: "4G" autoReleaseJob: false reserveOnFail: true userData: "key1 value1" disks: "local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency" tag: "TestTag" } output { File outTxtFile = "${txt_out}" File outDdFile = "${dd_out}" } }
Configsobject []

参考输入

Pathstring

参数路径

./config/example.json
Contentstring

参数内容

{ "wgs.apply_bqsr.cpu": 4, "wgs.apply_bqsr.disks": "local-disk 250 cloud_ssd", "wgs.apply_bqsr.gatk_Launcher": "/usr/local/bin/gatk-4.1.4.1/gatk", "wgs.apply_bqsr.java_opts": "'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt'", "wgs.apply_bqsr.memory": "8G"}
Pathstring

主 WDL 路径

main.wdl

示例

正常返回示例

JSON格式

{
  "WorkflowName": "MyTestWorkflow",
  "AppName": "MyTestApp",
  "CreateTime": "2021-06-16T15:09:14.378297+08:00",
  "Definition": "WDL content",
  "Description": "This is a test app",
  "Documentation": "example documentation content",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "Inputs": [
    {
      "TaskName": "TestTaskName",
      "VariableName": "TestVariableName",
      "VariableType": "TestVariableType",
      "VariableValue": "TestVariableValue",
      "Required": true,
      "Help": "help information",
      "StepOrder": 1
    }
  ],
  "Labels": {
    "key": "test"
  },
  "Language": "WDL",
  "LanguageVersion": "1.0",
  "LastModifiedTime": "2021-06-16T15:09:14.378297+08:00",
  "Outputs": [
    {
      "TaskName": "TestTaskName",
      "VariableName": "TestVariableName",
      "VariableType": "Int",
      "VariableValue": "ExampleValue",
      "Required": true,
      "Help": "Example help information",
      "StepOrder": 1
    }
  ],
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Revision": "1",
  "RevisionTag": "TestTag",
  "RevisionComment": "Example revision comment",
  "Revisions": [
    {
      "CreateTime": "2021-06-16T15:09:14.378297+08:00",
      "Revision": "1",
      "RevisionComment": "Example revision comment",
      "RevisionTag": "ProduceVersion"
    }
  ],
  "Scope": "Public",
  "URL": "Example url",
  "Workspace": "TestWorkspace",
  "Source": "EasyGene",
  "AppType": "App",
  "Dependencies": [
    {
      "Path": "./task/echo.wdl",
      "Content": "task echo {   String txt_out = \"default_txt_out\"   String dd_out = \"default_dd_out\"    command {     echo Hello > ${txt_out}     /bin/bash -c \"dd if=/dev/zero of=${dd_out} bs=1M count=15\"     echo \"This is a test std out.\"   }    runtime {     cpu: \"2\"     memory: \"4G\"     autoReleaseJob: false     reserveOnFail: true     userData: \"key1 value1\"     disks: \"local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency\"     tag: \"TestTag\"   }    output {     File outTxtFile = \"${txt_out}\"     File outDdFile = \"${dd_out}\"   } }"
    }
  ],
  "Configs": [
    {
      "Path": "./config/example.json",
      "Content": "{     \"wgs.apply_bqsr.cpu\": 4,     \"wgs.apply_bqsr.disks\": \"local-disk 250 cloud_ssd\",     \"wgs.apply_bqsr.gatk_Launcher\": \"/usr/local/bin/gatk-4.1.4.1/gatk\",     \"wgs.apply_bqsr.java_opts\": \"'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt'\",     \"wgs.apply_bqsr.memory\": \"8G\"}"
    }
  ],
  "Path": "main.wdl"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter %s is invalid.无效的参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.缺少必要的参数
404ResourceNotFoundThe specified resource %s is not found.访问的资源不存在。
404InvalidUser.NotFoundThe specified user is not found.找不到该用户信息,请先购买开通基因云产品

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:RevisionTag
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)