ListResourceGroups - 查看资源组列表 - 大数据开发治理平台 DataWorks

该接口用于查看指定类型的资源组列表。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:ListResourceGroups	get	TenantResourceGroup `acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/`	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupType	integer	是	需要查看的资源组类型 ID。取值如下： 0（DataWorks） 1（调度） 2（MaxCompute） 3（PAI） 4（数据集成） 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>	资源组列表。
Data	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（数据集成） 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	long	资源组的 ID。	1234567
TenantId	long	租户 ID。	1234567
ResourceManagerResourceGroupId	string	资源组 ID。	rg-acfmzbn7pti3zfa
Tags	array<object>	标签列表。
Tag	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.	用户不在租户中。

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

变更历史

变更时间	变更内容概要	操作
2022-12-13	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-10-31	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情