文档

CreateTemplate - 创建应用模板

工作空间中创建应用模板。

调试

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

授权信息

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

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

请求参数

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

工作空间名称

test-workspace
TemplateNamestring

应用模板名称

test-template
Descriptionstring

应用模板描述

This is a test template
AppNamestring

应用的名称

MyApp
AppRevisionstring

应用的版本

4.1.4.1-v1.0
RevisionTagstring

应用版本唯一标签

ProduceVersion
RootEntitystring

根实体类型

TestEntity
InputsExpressionobject []

应用的表达式

TestEntity
TaskNamestring

任务名称

Task1
VariableNamestring

变量名

fastq1
VariableTypestring

变量类型

File
VariableValuestring

变量值

oss://bucket/file1.fastq
Requiredboolean

该参数是否必填。

  • true:必填。
  • false:非必填。
说明 返回参数中,此参数无需处理。
true
Helpstring

帮助信息

test help
StepOrderinteger

步骤顺序

0
OutputsExpressionobject []

应用的输出参数

TaskNamestring

任务名称

Task1
VariableNamestring

变量名

bam
VariableTypestring

变量类型

File
VariableValuestring

变量值

oss://bucket/file.bam
Requiredboolean

该参数是否必填。

  • true:必填。
  • false:非必填。

默认值为 true。

true
Helpstring

帮助信息

输出比对结果
StepOrderinteger

步骤顺序

1
Labelsstring

应用标签

{"key1": "value1"}
ClientTokenstring

幂等 Token

GFjZT93cy1mMDE4OTgxNGU1ZTkK

返回参数

名称类型描述示例值
object

创建应用模板返回结果

Workspacestring

工作空间名称

test-workspace
TemplateNamestring

应用模板名称

test-template
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
RequestIdstring

请求 ID

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

示例

正常返回示例

JSON格式

{
  "Workspace": "test-workspace",
  "TemplateName": "test-template",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B"
}

错误码

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 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:RevisionTag
  • 本页导读 (0)
文档反馈