调用ListWorkspaces列出工作空间_基因分析平台-阿里云帮助中心

列出符合条件的工作空间。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
easygene:ListWorkspaces	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Search	string	否	查找条件	s1
OrderBy	string	否	排序依据	createtime
IsReversed	boolean	否	逆序	true
NextToken	string	否	查询起始 Token	TestToken
MaxResults	integer	否	最多返回数量	5
LabelSelector	string	否	Label 选择器	env=test

返回参数

名称	类型	描述	示例值
	object
HostId	string	主机 ID	easygene.cn-beijing.aliyuncs.com
MaxResults	integer	最大结果数	5
RequestId	string	请求 ID	DA980AD0-158F-44F3-847D-5EAB96C0EB6B
NextToken	string	下次查询的起始 Token	TestToken
TotalCount	integer	返回总个数	5
Workspaces	array<object>	工作空间数组
Workspaces	object
Description	string	工作空间描述	This is a test workspace
JobLifecycle	integer	任务生命周期	30
Labels	object	工作空间标签
	string	标签	test
Storage	string	OSS 工作路径	oss://my-bucket/my-path/
BucketName	string	工作空间 Bucket 名字	my-bucket
Role	string	RAM Role	TestRole
CreateTime	string	创建时间	2021-06-16T15:09:14.378297+08:00
LastModifiedTime	string	最后修改时间	2021-06-16T15:09:14.378297+08:00
Workspace	string	工作空间名称	TestWorkspace
Status	string	工作空间状态	Active
Location	string	地域 ID	cn-beijing

示例

正常返回示例

JSON格式

{
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "MaxResults": 5,
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "NextToken": "TestToken",
  "TotalCount": 5,
  "Workspaces": [
    {
      "Description": "This is a test workspace",
      "JobLifecycle": 30,
      "Labels": {
        "key": "test"
      },
      "Storage": "oss://my-bucket/my-path/",
      "BucketName": "my-bucket",
      "Role": "TestRole",
      "CreateTime": "2021-06-16T15:09:14.378297+08:00",
      "LastModifiedTime": "2021-06-16T15:09:14.378297+08:00",
      "Workspace": "TestWorkspace",
      "Status": "Active",
      "Location": "cn-beijing"
    }
  ]
}

错误码

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.	找不到该用户信息，请先购买开通基因云产品

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史