調用ListWorkspaces API擷取工作空間列表-開源巨量資料平台 E-MapReduce-阿里雲 - 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	否		cn-shenzhen-finance.edas.config.server
value	string	否		iPhone disk space remaining rate
resourceGroupId	string	否		rg-aek2thxggoqhmhq

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
workspaces	array<object>	工作空間清單。
	array<object>	工作空間詳細資訊。
workspaceId	string	Workspace ID。	w-******
workspaceName	string	工作空間名稱。	Spark batch workspace-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		23464687565
prePaidQuotaGpu	array<object>
	object
orderId	string		2534863936
instanceId	string		w-xxxxxxxxx-gpu-quota-xxxx
createTime	integer		1782292672000
expireTime	integer		1782292772000
autoRenewal	boolean
paymentStatus	string		NORMAL
gpuSpec	string		ecs.gn7i-c8g1.2xlarge
gpuNum	integer		8
gpuMachineNum	integer		4
instanceTypeId	string
instanceTypeFamily	string
cpuCoreCount	string
gpuAmount	integer
memorySize	string
gpuMemorySize	integer
tags	array<object>
	object
tagKey	string
tagValue	string
resourceGroupId	string		rg-xxxxxxxxxx
gpuSpec	array
	string		ecs.gn7i-c8g1.2xlarge
ipWhiteList	array
	string		0.0.0.1
requestId	string	請求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	下一頁 Token。	1
maxResults	integer	一次取得的最大記錄數。	20
totalCount	integer	記錄總數。	200

樣本

正常返回樣本

JSON格式

{
  "workspaces": [
    {
      "workspaceId": "w-******",
      "workspaceName": "Spark batch workspace-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": "23464687565"
      },
      "prePaidQuotaGpu": [
        {
          "orderId": "2534863936",
          "instanceId": "w-xxxxxxxxx-gpu-quota-xxxx",
          "createTime": 1782292672000,
          "expireTime": 1782292772000,
          "autoRenewal": true,
          "paymentStatus": "NORMAL",
          "gpuSpec": "ecs.gn7i-c8g1.2xlarge",
          "gpuNum": 8,
          "gpuMachineNum": 4,
          "instanceTypeId": "",
          "instanceTypeFamily": "",
          "cpuCoreCount": "",
          "gpuAmount": 0,
          "memorySize": "",
          "gpuMemorySize": 0
        }
      ],
      "tags": [
        {
          "tagKey": "",
          "tagValue": ""
        }
      ],
      "resourceGroupId": "rg-xxxxxxxxxx",
      "gpuSpec": [
        "ecs.gn7i-c8g1.2xlarge"
      ],
      "ipWhiteList": [
        "0.0.0.1"
      ]
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。