調用ListResourceGroups API查看指定類型資源群組列表-巨量資料開發治理平台 DataWorks-阿里雲

該介面用於查看指定類型的資源群組列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
ResourceGroupType	integer	否	需要查看的資源群組類型 ID。取值如下： 0（DataWorks） 1（調度） 2（MaxCompute） 3（PAI） 4（Data Integration） 7 （下單購買獨享調度資源群組時，產生的購買資源 ID） 9 （dataService）預設取值為 1（調度）。當取值表示引擎時，查看的資源群組列表為購買該類型引擎時建立的資源群組列表。	3
Keyword	string	否	關鍵字。用於模糊查詢資源群組名稱和資源群組標識。	abc
BizExtKey	string	否	資源群組的類別。取值如下： default：預設值，公用資源群組。 single：獨享資源群組。	default
ResourceManagerResourceGroupId	string	否	資源群組 ID。	rg-acfmzbn7pti3zfa
Tags	array<object>	否	標籤列表。
	object	否	標籤資訊。
Key	string	否	標籤鍵。	Env
Value	string	否	標籤值。	Test

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
HttpStatusCode	integer	請求返回碼。	200
RequestId	string	請求 ID。	0bc1411515937635973****
Success	boolean	請求是否成功。	true
Data	array<object>	資源群組列表。
	array<object>	資源群組詳情。
Status	integer	資源群組的狀態。取值如下： NORMAL(0)，表示資源群組狀態正常，處於運行中或服務中。 STOP(1)，表示資源群組已到期，處於凍結狀態。 DELETED(2)，表示資源群組已被釋放或銷毀。 CREATING(3)，表示資源群組正在建立或啟動。 CREATE_FAILED(4)，表示資源群組建立或啟動失敗。 UPDATING(5)，表示資源群組正在擴容或升級。 UPDATE_FAILED(6)，表示資源群組擴容或升級失敗。 DELETING(7)，表示資源群組正在被釋放或銷毀。 DELETE_FAILED(8)，表示資源群組釋放或銷毀失敗。 TIMEOUT(9)，表示對資源群組執行的操作逾時。所有變更操作均可能會逾時，該枚舉值暫時僅提供給資料服務使用。	0
UpdateTime	string	最近一次更新資源群組的時間。	Jul 9, 2018 2:43:37 PM
IsDefault	boolean	是否為預設資源群組。取值如下： true：是預設資源群組。 false：非預設資源群組。	true
Cluster	string	叢集的名稱。該參數僅對於 MaxCompute 和 PAI 資源群組類型生效。	AY18G
EnableKp	boolean	是否使用 Kp（關鍵人）訪問。取值如下： true：表示 MaxCompute 引擎使用阿里雲帳號 UID 作為訪問賬戶的顯示名稱。 false：表示 MaxCompute 引擎使用阿里雲帳號名稱作為訪問賬戶的顯示名稱。其餘類型無意義。該參數僅對 MaxCompute 引擎生效。	false
ResourceGroupType	string	資源群組的類型。取值如下： 0（DataWorks） 2（MaxCompute） 3（PAI） 4（Data Integration） 7（調度） 9 （dataService）	3
CreateTime	string	建立叢集的時間。格式樣本為 Jul 9, 2018 2:43:37 PM。	Jul 9, 2018 2:43:37 PM
Identifier	string	資源群組的標識。	e1815577-2f4e-4c5e-b29****
Mode	string	資源群組的類型。取值如下： ISOLATE：表示預付費的獨享資源群組。 SHARE：表示後付費的公用資源群組。 DEVELOP：表示開發人員版本。	SHARE
BizExtKey	string	資源群組的類別。取值如下： default，公用資源群組。 single，獨享資源群組。	default
Sequence	integer	序欄欄位。用於將已建立的資源群組按照建立的序號從小到大升序排序。	300
Specs	object	資源群組的詳細資料。{}中顯示的內容為資源群組的詳細資料。	{}
Name	string	資源群組的名稱。	abc
Id	integer	資源群組的 ID。	1234567
TenantId	integer	租戶 ID。	1234567
ResourceManagerResourceGroupId	string	資源群組 ID。	rg-acfmzbn7pti3zfa
Tags	array<object>	標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	Env
Value	string	標籤值。	Test

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": [
    {
      "Status": 0,
      "UpdateTime": "Jul 9, 2018 2:43:37 PM",
      "IsDefault": true,
      "Cluster": "AY18G",
      "EnableKp": false,
      "ResourceGroupType": "3",
      "CreateTime": "Jul 9, 2018 2:43:37 PM",
      "Identifier": "e1815577-2f4e-4c5e-b29****",
      "Mode": "SHARE",
      "BizExtKey": "default",
      "Sequence": 300,
      "Specs": {},
      "Name": "abc",
      "Id": 1234567,
      "TenantId": 1234567,
      "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
      "Tags": [
        {
          "Key": "Env",
          "Value": "Test"
        }
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	資料來源不存在。
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	專案不存在。
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	使用者不在專案中。
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	使用者不是專案負責人或者專案系統管理員。
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	使用者不在租戶中。

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

變更歷史

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