ListWorkspaces - 获取工作空间列表_开源大数据平台 E-MapReduce(EMR)-阿里云帮助中心

调用ListWorkspaces获取工作空间列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/workspaces

请求参数

名称	类型	必填	描述	示例值
nextToken	string	否	标记当前开始读取的位置。	1
maxResults	integer	否	一次获取的最大记录数。	20
name	string	否	根据工作空间名称模糊搜索。	test_workspace
state	string	否	工作空间状态	running
regionId	string	否	区域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	返回数据。
workspaces	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	long	工作空间创建时间。	1684115879955
endTime	long	工作空间释放时间。	1687103999999
stateChangeReason	object	工作空间状态的变更信息。
code	string	错误码。	0
message	string	错误信息。	Success
releaseType	string	工作空间释放原因。	SERVICE_RELEASE
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"
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

错误码

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