列出符合条件的工作空间。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
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> |
工作空间数组 |
|
|
array<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 |
创建时间,采用 RFC 3339 格式并包含时区信息,例如 2021-06-16T15:09:14.378297+08:00。 |
2021-06-16T15:09:14.378297+08:00 |
| LastModifiedTime |
string |
最后修改时间,采用 RFC 3339 格式并包含时区信息,例如 2021-06-16T15:09:14.378297+08:00。 |
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. | 找不到该用户信息,请先购买开通基因云产品 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。