调用ListWorkspaces获取工作空间列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| emr-serverless-spark:ListWorkspaces | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/workspaces HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| nextToken | string | 否 | 标记当前开始读取的位置。 | 1 |
| maxResults | integer | 否 | 一次获取的最大记录数。 | 20 |
| name | string | 否 | 根据工作空间名称模糊搜索。 | test_workspace |
| state | string | 否 | 工作空间状态 | running |
| regionId | string | 否 | 区域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON格式
{
"workspaces": [
{
"workspaceId": "w-******",
"workspaceName": "spark批作业空间-1",
"resourceSpec": "100cu",
"storage": "spark-result",
"dlfCatalogId": "default",
"paymentType": "PayAsYouGo or Subscription",
"paymentDurationUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
"duration": 1,
"autoRenew": true,
"autoRenewPeriod": 1,
"autoRenewPeriodUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
"workspaceStatus": "STARTING,RUNNING,TERMINATED",
"failReason": "out of stock",
"paymentStatus": "PAID/UNPAID",
"regionId": "cn-shanghai",
"createTime": 1684115879955,
"endTime": 1687103999999,
"stateChangeReason": {
"code": "0",
"message": "Success"
},
"releaseType": "SERVICE_RELEASE",
"dlfType": ""
}
],
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
"nextToken": "1",
"maxResults": 20,
"totalCount": 200
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |