工作空间中创建应用模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
easygene:CreateTemplate |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Workspace | string | 是 | 工作空间名称 | test-workspace |
TemplateName | string | 是 | 应用模板名称 | test-template |
Description | string | 否 | 应用模板描述 | This is a test template |
AppName | string | 是 | 应用的名称 | MyApp |
AppRevision | string | 否 | 应用的版本 | 4.1.4.1-v1.0 |
RevisionTag | string | 否 | 应用版本唯一标签 | ProduceVersion |
RootEntity | string | 否 | 根实体类型 | TestEntity |
InputsExpression | array<object> | 是 | 应用的表达式 | TestEntity |
object | 是 | 应用的表达式 | ||
TaskName | string | 是 | 任务名称 | Task1 |
VariableName | string | 是 | 变量名 | fastq1 |
VariableType | string | 是 | 变量类型 | File |
VariableValue | string | 是 | 变量值 | oss://bucket/file1.fastq |
Required | boolean | 是 | 该参数是否必填。
说明
返回参数中,此参数无需处理。
| true |
Help | string | 否 | 帮助信息 | test help |
StepOrder | integer | 否 | 步骤顺序 | 0 |
OutputsExpression | array<object> | 是 | 应用的输出参数 | |
object | 是 | 应用的输出 | ||
TaskName | string | 是 | 任务名称 | Task1 |
VariableName | string | 是 | 变量名 | bam |
VariableType | string | 是 | 变量类型 | File |
VariableValue | string | 是 | 变量值 | oss://bucket/file.bam |
Required | boolean | 是 | 该参数是否必填。
默认值为 true。 | true |
Help | string | 否 | 帮助信息 | 输出比对结果 |
StepOrder | integer | 否 | 步骤顺序 | 1 |
Labels | string | 否 | 应用标签 | {"key1": "value1"} |
ClientToken | string | 否 | 幂等 Token | GFjZT93cy1mMDE4OTgxNGU1ZTkK |
返回参数
示例
正常返回示例
JSON
格式
{
"Workspace": "test-workspace",
"TemplateName": "test-template",
"HostId": "easygene.cn-beijing.aliyuncs.com",
"RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B"
}
错误码
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-01-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |