调用ListWorkspaces获取工作空间列表-开源大数据平台 E-MapReduce-阿里云

调用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
tag	array<object>	否
	object	否
key	string	否
value	string	否

返回参数

名称	类型	描述	示例值
	object	返回数据。
workspaces	array<object>	工作空间列表。
	array<object>	工作空间详情。
workspaceId	string	Workspace ID。	w-******
workspaceName	string	工作空间名称。	spark批作业空间-1
resourceSpec	string	资源规格。	100cu
storage	string	OSS 路径。	spark-result
dlfCatalogId	string	DLF Catalog 信息。	default
paymentType	string	付费类型。	PayAsYouGo or Subscription
paymentDurationUnit	string	订购周期（pre 付费类型必填）。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
duration	integer	订购周期数量（pre 付费类型必填）。	1
autoRenew	boolean	是否自动续费（pre 付费类型必填）。	true
autoRenewPeriod	integer	自动续费时长（pre 付费类型必填）。	1
autoRenewPeriodUnit	string	自动续费周期（pre 付费类型必填）。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
workspaceStatus	string	工作空间状态。	STARTING,RUNNING,TERMINATED
failReason	string	失败原因。	out of stock
paymentStatus	string	支付状态。	PAID/UNPAID
regionId	string	地域 ID。	cn-shanghai
createTime	integer	工作空间创建时间。	1684115879955
endTime	integer	工作空间释放时间。	1687103999999
stateChangeReason	object	工作空间状态的变更信息。
code	string	错误码。	0
message	string	错误信息。	Success
releaseType	string	工作空间释放原因。	SERVICE_RELEASE
dlfType	string	绑定 dlf 类型。	1.0
prePaidQuota	object	预付费资源配额的信息。
usedResource	string	当前已使用的资源量。	{\"cpu\":\"0\",\"memory\":\"0Gi\",\"cu\":\"0\"}
maxResource	string	可使用的最大资源量。	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
allocatedResource	string	当前已分配的资源量。	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
createTime	integer	资源配额的创建时间。	1745683200000
expireTime	integer	资源配额的过期时间。	1740537153000
autoRenewal	boolean	资源是否开启了自动续费功能。 true：开启自动续费，资源到期后会自动续订。 false：未开启自动续费，资源到期后将停止使用。	true
paymentStatus	string	当前资源的支付状态。取值如下： NORMAL：有效中。 WAIT_FOR_EXPIRE：将过期。 EXPIRED：已过期。	NORMAL
instanceId	string	与该配额关联的资源实例 ID。	i-abc12345
orderId	string
tags	array<object>
	object
tagKey	string
tagValue	string
requestId	string	请求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	下一页 TOKEN。	1
maxResults	integer	一次获取的最大记录数。	20
totalCount	integer	记录总数。	200

示例

正常返回示例

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": "1.0",
      "prePaidQuota": {
        "usedResource": "{\\\"cpu\\\":\\\"0\\\",\\\"memory\\\":\\\"0Gi\\\",\\\"cu\\\":\\\"0\\\"}",
        "maxResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "allocatedResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "createTime": 1745683200000,
        "expireTime": 1740537153000,
        "autoRenewal": true,
        "paymentStatus": "NORMAL",
        "instanceId": "i-abc12345",
        "orderId": ""
      },
      "tags": [
        {
          "tagKey": "",
          "tagValue": ""
        }
      ]
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

错误码

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

变更历史

更多信息，参考变更详情。