获取某个地域下的工作空间列表。
接口说明
您可以通过option参数指定不同的查询选项，来获取不同的工作空间相关信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pai:ListWorkspaces | List |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | long | 否 | 工作空间列表的页码。起始值为1，默认为1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数，默认为20。 | 20 |
| SortBy | string | 否 | 分页查询时的排序字段，默认使用GmtCreateTime。取值如下。
| GmtCreateTime |
| Order | string | 否 | 分页查询时，对指定的排序字段进行升序或降序。取值如下：
| ASC |
| WorkspaceName | string | 否 | 工作空间名称。 | abc |
| ModuleList | string | 否 | 逗号分割的模块列表。默认值：PAI。 | PAI |
| Status | string | 否 | 工作空间状态，目前支持如下值：
| ENABLED |
| Option | string | 否 | 选项，取值如下：
| GetWorkspaces |
| Verbose | boolean | 否 | 是否显示工作空间详细信息。取值如下：
| true |
| Fields | string | 否 | 工作空间详情的返回字段列表。用于限定返回结果中的工作空间属性。 多个属性用半角逗号（,）分隔。目前只支持Id，表示工作空间ID。 | Id |
| WorkspaceIds | string | 否 | 工作空间ID列表。多个工作空间ID用半角逗号（,）分隔。 | 123,234 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
"Workspaces": [
{
"WorkspaceId": "123",
"WorkspaceName": "workspace-example",
"GmtCreateTime": "2021-01-21T17:12:35.232Z",
"GmtModifiedTime": "2021-01-21T17:12:35.232Z",
"Description": "workspace description example",
"Creator": "122424353535",
"EnvTypes": [
"prod"
],
"Status": "ENABLED",
"AdminNames": [
"demo_test@***.aliyunid.com"
],
"IsDefault": false,
"ExtraInfos": {
"test": "test",
"test2": 1
}
}
],
"TotalCount": 1,
"ResourceLimits": {
"test": "test",
"test2": 1
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2021-03-02 | OpenAPI 返回结构发生变更 | |||||
| ||||||
| 2021-03-02 | OpenAPI 入参发生变更 | |||||
| ||||||
| 2021-03-02 | OpenAPI 返回结构发生变更 | |||||
|
