工作空间中创建应用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
easygene:CreateApp | create | *App acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Workspace | string | 是 | 工作空间名称 | TestWorkspace |
AppName | string | 是 | 应用名称 | TestApp |
Definition | string | 是 | 应用定义 | import "./task/echo.wdl" as echo workflow wf_echo { call echo.echo } |
Path | string | 是 | 主 WDL 路径 | main.wdl |
RevisionTag | string | 否 | 应用版本标签,在所有版本间具有唯一性 | ProduceVersion |
Description | string | 否 | 应用描述 | This is a test app |
Language | string | 否 | 应用描述语言 | WDL |
LanguageVersion | string | 否 | 应用描述语语言版本 | 1.0 |
AppType | string | 否 | 应用类型 | App |
Documentation | string | 否 | 应用使用文档 | Example documentation content |
RevisionComment | string | 否 | 应用当前版本说明 | Example revision comment |
Labels | string | 否 | 应用标签 | {"key":"value"} |
ClientToken | string | 否 | 幂等 Token | TestToken |
Dependencies | array<object> | 否 | 依赖应用 | {"key":"value"} |
object | 否 | |||
Path | string | 否 | 依赖路径 | ./task/echo.wdl |
Content | string | 否 | 依赖内容 | 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 | array<object> | 否 | 参考输入 | TestToken |
object | 否 | |||
Path | string | 否 | 配置路径 | ./config/example.json |
Content | string | 否 | 配置内容 | { "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"} |
返回参数
示例
正常返回示例
JSON
格式
{
"Workspace": "TestWorkspace",
"AppName": "TestApp",
"HostId": "easygene.cn-beijing.aliyuncs.com",
"RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
"Revision": "1",
"RevisionTag": "ProduceVersion"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter %s is invalid. | 无效的参数 |
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 缺少必要的参数 |
404 | InvalidUser.NotFound | The specified user is not found. | 找不到该用户信息,请先购买开通基因云产品 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-10 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-12 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |