文档

GetTemplate - 查询应用模板详情

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

调试

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

授权信息

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

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

请求参数

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

工作空间名称

test-workspace
TemplateNamestring

应用模板名称

test-template

返回参数

名称类型描述示例值
object

应用模板详情

TemplateNamestring

应用模板名称

test-template
CreateTimestring

创建时间

2021-06-10T13:30:20.414557061Z
Descriptionstring

应用简要描述

test template
AppNamestring

应用的名称

MyApp
AppRevisionstring

应用的版本

1
HostIdstring

主机 ID

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

应用输入

TaskNamestring

任务名称

Task1
VariableNamestring

变量名称

v1
VariableTypestring

变量类型

File
VariableValuestring

变量值

oss://bucket/file1.fastq
Requiredboolean

是否必须参数

true
Helpstring

帮助信息

test help
StepOrderlong

步骤顺序

0
Labelsobject

应用标签

string

标签

test
LastModifiedTimestring

应用最后修改时间

2021-06-10T13:30:20.405878292Z
OutputsExpressionobject []

应用的输出参数

TaskNamestring

任务名称

jobname
VariableNamestring

变量名称

fastq1
VariableTypestring

变量类型

string
VariableValuestring

变量值

abc_1.fastq.gz
Requiredboolean

是否必须参数

true
Helpstring

帮助信息

测序reads文件
StepOrderlong

步骤顺序

2
RequestIdstring

请求 ID

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

应用来源

EasyGene
Workspacestring

工作空间名称

test-workspace
RootEntitystring

实体类型

test-entity
RevisionTagstring

应用版本唯一标签

produceVersion

示例

正常返回示例

JSON格式

{
  "TemplateName": "test-template",
  "CreateTime": "2021-06-10T13:30:20.414557061Z",
  "Description": "test template",
  "AppName": "MyApp",
  "AppRevision": "1",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "InputsExpression": [
    {
      "TaskName": "Task1",
      "VariableName": "v1",
      "VariableType": "File",
      "VariableValue": "oss://bucket/file1.fastq",
      "Required": true,
      "Help": "test help",
      "StepOrder": 0
    }
  ],
  "Labels": {
    "key": "test"
  },
  "LastModifiedTime": "2021-06-10T13:30:20.405878292Z",
  "OutputsExpression": [
    {
      "TaskName": "jobname",
      "VariableName": "fastq1",
      "VariableType": "string",
      "VariableValue": "abc_1.fastq.gz",
      "Required": true,
      "Help": "测序reads文件",
      "StepOrder": 2
    }
  ],
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Source": "EasyGene",
  "Workspace": "test-workspace",
  "RootEntity": "test-entity",
  "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 返回结构发生变更
  • 本页导读 (0)
文档反馈