获取工作空间下应用模板列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTemplates

系统规定参数。取值:ListTemplates

Workspace String test-workspace

工作空间

NextToken String MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK

下次查询起始位置

MaxResults Integer 10

最大返回结果数

OrderBy String createtime

排序依据

IsReversed Boolean false

是否逆序

LabelSelector String key1=value1

Label 选择器

Search String test

查找条件

RegionId String cn-beijing

区域

返回数据

名称 类型 示例值 描述
HostId String easygene.cn-beijing.aliyuncs.com

主机ID

MaxResults Integer 10

最大返回结果

NextToken String MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK

下次查询Token

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

请求ID

Templates Array of Templates

应用模板列表

Workspace String test-workspace

工作空间

TemplateName String test-template

应用模板名称

Labels Map

标签

String test

标签

AppName String my-app

应用名称

Revision String 1

应用版本

RootEntity String test-entity

实体类型

Inputs Array of Inputs

应用输入

TaskName String task1

任务名称

VariableName String fastq1

变量名称

VariableType String File

变量类型

VariableValue String oss://bucket/file1.fastq

变量值

Required Boolean true

是否必须参数

Help String help test

帮助信息

StepOrder Long 0

步骤顺序

Outputs Array of Outputs

应用的输出参数

TaskName String task1

任务名称

VariableName String v1

变量名称

VariableType String File

变量类型

VariableValue String oss://bucket/test.vcf

变量值

Required Boolean true

是否必须参数

Help String help test

帮助信息

StepOrder Long 1

步骤顺序

Description String This is a test template

模板描述信息

CreateTime String 2021-06-10T13:30:20.414557061Z

创建时间

LastModifiedTime String 2021-06-10T13:30:20.414557061Z

最后修改时间

TotalCount Integer 10

返回个数

示例

请求示例

http(s)://[Endpoint]/?Action=ListTemplates
&Workspace=test-workspace
&NextToken=MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
&MaxResults=10
&OrderBy=createtime
&IsReversed=false
&LabelSelector=key1=value1
&Search=test
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTemplatesResponse>
    <HostId>easygene.cn-beijing.aliyuncs.com</HostId>
    <MaxResults>10</MaxResults>
    <NextToken>MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK</NextToken>
    <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>
    <Templates>
        <Workspace>test-workspace</Workspace>
        <TemplateName>test-template</TemplateName>
        <AppName>my-app</AppName>
        <Revision>1</Revision>
        <RootEntity>test-entity</RootEntity>
        <Inputs>
            <TaskName>task1</TaskName>
            <VariableName>fastq1</VariableName>
            <VariableType>File</VariableType>
            <VariableValue>oss://bucket/file1.fastq</VariableValue>
            <Required>true</Required>
            <Help>help test</Help>
            <StepOrder>0</StepOrder>
        </Inputs>
        <Outputs>
            <TaskName>task1</TaskName>
            <VariableName>v1</VariableName>
            <VariableType>File</VariableType>
            <VariableValue>oss://bucket/test.vcf</VariableValue>
            <Required>true</Required>
            <Help>help test</Help>
            <StepOrder>1</StepOrder>
        </Outputs>
        <Description>This is a test template</Description>
        <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>
        <LastModifiedTime>2021-06-10T13:30:20.414557061Z</LastModifiedTime>
    </Templates>
    <TotalCount>10</TotalCount>
</ListTemplatesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HostId" : "easygene.cn-beijing.aliyuncs.com",
  "MaxResults" : 10,
  "NextToken" : "MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK",
  "RequestId" : "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Templates" : [ {
    "Workspace" : "test-workspace",
    "TemplateName" : "test-template",
    "AppName" : "my-app",
    "Revision" : "1",
    "RootEntity" : "test-entity",
    "Inputs" : [ {
      "TaskName" : "task1",
      "VariableName" : "fastq1",
      "VariableType" : "File",
      "VariableValue" : "oss://bucket/file1.fastq",
      "Required" : true,
      "Help" : "help test",
      "StepOrder" : 0
    } ],
    "Outputs" : [ {
      "TaskName" : "task1",
      "VariableName" : "v1",
      "VariableType" : "File",
      "VariableValue" : "oss://bucket/test.vcf",
      "Required" : true,
      "Help" : "help test",
      "StepOrder" : 1
    } ],
    "Description" : "This is a test template",
    "CreateTime" : "2021-06-10T13:30:20.414557061Z",
    "LastModifiedTime" : "2021-06-10T13:30:20.414557061Z"
  } ],
  "TotalCount" : 10
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidUser.NotFound The specified user is not found. 找不到该用户信息,请先购买开通基因云产品
404 ResourceNotFound The specified resource %s is not found. 访问的资源不存在。
400 InvalidParameter The specified parameter %s is invalid: %s. 参数不合法,请检查参数是否正确。
500 InternalServerError An internal error has occurred. Please try again. 内部错误,请重试。
403 AccessDenied The access key ID is disabled %s. 您使用的Access key ID 已经被禁用。
403 AccessDenied The caller is not authorized to perform %s on resource %s. 没有权限进行相关的操作,请检查子账号权限是否正确。
403 AccessDenied The resources do not belong to you. 您访问的资源不属于当前账号。
403 AccessDenied The STS token is invalid. STS token 非法。

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

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