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

调试

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

请求参数

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

系统规定参数。取值:ListApps

Workspace String TestWorkspace

工作空间

NextToken String TestToken

Next Token

MaxResults Integer 5

最大返回结果数

OrderBy String createtime

排序依据

IsReversed Boolean true

是否逆序

LabelSelector String env=test

Label 选择器

Scope String Public

应用范围

Language String WDL

应用描述语言

AppType String App

应用类型

Name String TestName

按照名字匹配

RegionId String cn-beijing

区域

返回数据

名称 类型 示例值 描述
Apps Array of Apps

应用数组

AppName String TestApp

应用名称

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

创建时间

Description String This is a test app

应用描述

AppType String App

应用类型

Language String WDL

应用描述语言

Scope String Public

应用可见范围

Workspace String TestWorkspace

应用所在工作空间

Source String EasyGene

应用来源

Namespace String TestNamespace

命名空间

AppOrigName String TestOrigName

应用原名

AppDefaultVersion String v1

默认版本

Labels Map

标签

String test

标签

HostId String easygene.cn-beijing.aliyuncs.com

主机ID

MaxResults Integer 5

最大返回个数

NextToken String TestToken

Next Token

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

请求ID

TotalCount Integer 5

返回个数

示例

请求示例

http(s)://[Endpoint]/?Action=ListApps
&Workspace=TestWorkspace
&NextToken=TestToken
&MaxResults=5
&OrderBy=createtime
&IsReversed=true
&LabelSelector=env=test
&Scope=Public
&Language=WDL
&AppType=App
&Name=TestName
&公共请求参数

正常返回示例

XML格式

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

<ListAppsResponse>
    <Apps>
        <AppName>TestApp</AppName>
        <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>
        <Description>This is a test app</Description>
        <AppType>App</AppType>
        <Language>WDL</Language>
        <Scope>Public</Scope>
        <Workspace>TestWorkspace</Workspace>
        <Source>EasyGene</Source>
        <Namespace>TestNamespace</Namespace>
        <AppOrigName>TestOrigName</AppOrigName>
        <AppDefaultVersion>v1</AppDefaultVersion>
        <Labels>
            <key>test</key>
        </Labels>
    </Apps>
    <HostId>easygene.cn-beijing.aliyuncs.com</HostId>
    <MaxResults>5</MaxResults>
    <NextToken>TestToken</NextToken>
    <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>
    <TotalCount>5</TotalCount>
</ListAppsResponse>

JSON格式

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

{
  "Apps" : [ {
    "AppName" : "TestApp",
    "CreateTime" : "2021-06-10T13:30:20.414557061Z",
    "Description" : "This is a test app",
    "AppType" : "App",
    "Language" : "WDL",
    "Scope" : "Public",
    "Workspace" : "TestWorkspace",
    "Source" : "EasyGene",
    "Namespace" : "TestNamespace",
    "AppOrigName" : "TestOrigName",
    "AppDefaultVersion" : "v1",
    "Labels" : {
      "key" : "test"
    }
  } ],
  "HostId" : "easygene.cn-beijing.aliyuncs.com",
  "MaxResults" : 5,
  "NextToken" : "TestToken",
  "RequestId" : "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "TotalCount" : 5
}

错误码

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 非法。

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

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