文档

ListTemplates - 获取应用模板列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

工作空间

test-workspace
NextTokenstring

下次查询起始位置

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
MaxResultsinteger

最大返回结果数

10
OrderBystring

排序依据

createtime
IsReversedboolean

是否逆序

false
LabelSelectorstring

Label 选择器

key1=value1
Searchstring

查找条件

test

返回参数

名称类型描述示例值
object

响应结果

HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
MaxResultsinteger

最大返回结果

10
NextTokenstring

下次查询 Token

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
Templatesobject []

应用模板列表

Workspacestring

工作空间

test-workspace
TemplateNamestring

应用模板名称

test-template
Labelsobject

标签

string

标签

test
AppNamestring

应用名称

my-app
AppRevisionstring

应用版本

1
RootEntitystring

实体类型

test-entity
InputsExpressionobject []

应用输入

TaskNamestring

任务名称

task1
VariableNamestring

变量名称

fastq1
VariableTypestring

变量类型

File
VariableValuestring

变量值

oss://bucket/file1.fastq
Requiredboolean

是否必须参数

true
Helpstring

帮助信息

help test
StepOrderlong

步骤顺序

0
OutputsExpressionobject []

应用的输出参数

TaskNamestring

任务名称

task1
VariableNamestring

变量名称

v1
VariableTypestring

变量类型

File
VariableValuestring

变量值

oss://bucket/test.vcf
Requiredboolean

是否必须参数

true
Helpstring

帮助信息

help test
StepOrderlong

步骤顺序

1
Descriptionstring

模板描述信息

This is a test template
CreateTimestring

创建时间

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

最后修改时间

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

应用版本唯一标签

ProduceVersion
TotalCountinteger

返回个数

10

示例

正常返回示例

JSON格式

{
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "MaxResults": 10,
  "NextToken": "MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK",
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Templates": [
    {
      "Workspace": "test-workspace",
      "TemplateName": "test-template",
      "Labels": {
        "key": "test"
      },
      "AppName": "my-app",
      "AppRevision": "1",
      "RootEntity": "test-entity",
      "InputsExpression": [
        {
          "TaskName": "task1",
          "VariableName": "fastq1",
          "VariableType": "File",
          "VariableValue": "oss://bucket/file1.fastq",
          "Required": true,
          "Help": "help test",
          "StepOrder": 0
        }
      ],
      "OutputsExpression": [
        {
          "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",
      "RevisionTag": "ProduceVersion"
    }
  ],
  "TotalCount": 10
}

错误码

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-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)