調用ListWorkspaces獲取工作空間列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
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 返回結構發生變更 | 查看變更詳情 |