全部产品
Search
文档中心

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

更新时间:Jul 09, 2024

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ResourceGroupTypeinteger

需要查看的资源组类型 ID。取值如下:

  • 0(DataWorks)
  • 1(调度)
  • 2(MaxCompute)
  • 3(PAI)
  • 4(数据集成)
  • 7 (下单购买独享调度资源组时,生成的购买资源 ID)
  • 9 (dataService)
  • 默认取值为 1(调度)。

当取值表示引擎时,查看的资源组列表为购买该类型引擎时创建的资源组列表。

3
Keywordstring

关键字。用于模糊查询资源组名称和资源组标识。

abc
BizExtKeystring

资源组的类别。取值如下:

  • default:默认值,公共资源组。
  • single:独享资源组。
default
ResourceManagerResourceGroupIdstring

资源组 ID。

rg-acfmzbn7pti3zfa
Tagsarray<object>

标签列表。

object

标签信息。

Keystring

标签键。

Env
Valuestring

标签值。

Test

返回参数

名称类型描述示例值
object

返回结果。

HttpStatusCodeinteger

请求返回码。

200
RequestIdstring

请求 ID。

0bc1411515937635973****
Successboolean

请求是否成功。

true
Dataarray<object>

资源组列表。

object

资源组详情。

Statusinteger

资源组的状态。取值如下:

  • NORMAL(0),表示资源组状态正常,处于运行中或服务中。
  • STOP(1),表示资源组已到期,处于冻结状态。
  • DELETED(2),表示资源组已被释放或销毁。
  • CREATING(3),表示资源组正在创建或启动。
  • CREATE_FAILED(4),表示资源组创建或启动失败。
  • UPDATING(5),表示资源组正在扩容或升级。
  • UPDATE_FAILED(6),表示资源组扩容或升级失败。
  • DELETING(7),表示资源组正在被释放或销毁。
  • DELETE_FAILED(8),表示资源组释放或销毁失败。
  • TIMEOUT(9),表示对资源组执行的操作超时。所有变更操作均可能会超时,该枚举值暂时仅提供给数据服务使用。
0
UpdateTimestring

最近一次更新资源组的时间。

Jul 9, 2018 2:43:37 PM
IsDefaultboolean

是否为默认资源组。取值如下:

  • true:是默认资源组。
  • false:非默认资源组。
true
Clusterstring

集群的名称。该参数仅对于 MaxCompute 和 PAI 资源组类型生效。

AY18G
EnableKpboolean

是否使用 Kp(关键人)访问。取值如下:

  • true:表示 MaxCompute 引擎使用阿里云账号 UID 作为访问账户的显示名称。
  • false:表示 MaxCompute 引擎使用阿里云账号名称作为访问账户的显示名称。 其余类型无意义。该参数仅对 MaxCompute 引擎生效。
false
ResourceGroupTypestring

资源组的类型。取值如下:

  • 0(DataWorks)
  • 2(MaxCompute)
  • 3(PAI)
  • 4(数据集成)
  • 7(调度)
  • 9 (dataService)
3
CreateTimestring

创建集群的时间。格式示例为 Jul 9, 2018 2:43:37 PM。

Jul 9, 2018 2:43:37 PM
Identifierstring

资源组的标识。

e1815577-2f4e-4c5e-b29****
Modestring

资源组的类型。取值如下:

  • ISOLATE:表示预付费的独享资源组。
  • SHARE:表示后付费的公共资源组。
  • DEVELOP:表示开发者版本。
SHARE
BizExtKeystring

资源组的类别。取值如下:

  • default,公共资源组。
  • single,独享资源组。
default
Sequenceinteger

序列字段。用于将已创建的资源组按照创建的序号从小到大升序排序。

300
Specsobject

资源组的详细信息。{}中显示的内容为资源组的详细信息。

{}
Namestring

资源组的名称。

abc
Idlong

资源组的 ID。

1234567
TenantIdlong

租户 ID。

1234567
ResourceManagerResourceGroupIdstring

资源组 ID。

rg-acfmzbn7pti3zfa
Tagsarray<object>

标签列表。

object

标签信息。

Keystring

标签键。

Env
Valuestring

标签值。

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错误码错误信息描述
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.数据源不存在。
400Invalid.Tenant.ProjectNotExistsThe project does not exist.项目不存在。
400Invalid.Tenant.UserNotInProjectThe user is not in the project.用户不在项目中。
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.用户不是项目负责人或者项目管理员。
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.用户不在租户中。

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

变更历史

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