文档

CreateApp - 创建应用

工作空间中创建应用。

调试

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

授权信息

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

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

请求参数

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

工作空间名称

TestWorkspace
AppNamestring

应用名称

TestApp
Definitionstring

应用定义

import "./task/echo.wdl" as echo workflow wf_echo { call echo.echo }
Pathstring

主 WDL 路径

main.wdl
RevisionTagstring

应用版本标签,在所有版本间具有唯一性

ProduceVersion
Descriptionstring

应用描述

This is a test app
Languagestring

应用描述语言

WDL
LanguageVersionstring

应用描述语语言版本

1.0
AppTypestring

应用类型

App
Documentationstring

应用使用文档

Example documentation content
RevisionCommentstring

应用当前版本说明

Example revision comment
Labelsstring

应用标签

{"key":"value"}
ClientTokenstring

幂等 Token

TestToken
Dependenciesobject []

依赖应用

{"key":"value"}
Pathstring

依赖路径

./task/echo.wdl
Contentstring

依赖内容

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 []

参考输入

TestToken
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"}

返回参数

名称类型描述示例值
object

创建应用返回结果

Workspacestring

工作空间

TestWorkspace
AppNamestring

应用名称

TestApp
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
RequestIdstring

请求 ID

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

应用版本号

1
RevisionTagstring

应用版本唯一标签

ProduceVersion

示例

正常返回示例

JSON格式

{
  "Workspace": "TestWorkspace",
  "AppName": "TestApp",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Revision": "1",
  "RevisionTag": "ProduceVersion"
}

错误码

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

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

变更历史

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