GetResourceGroup - 根据ID获取指定资源组信息

更新时间:
复制 MD 格式

根据ID获取指定资源组信息。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetResourceGroup

get

*DwResourceGroup

acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}

请求参数

名称

类型

必填

描述

示例值

Id

string

通用资源组唯一标识。

Serverless_res_group_524257424564736_6831777003XXXXX

返回参数

名称

类型

描述

示例值

object

Schema of Response

Success

boolean

是否请求成功。

true

ResourceGroup

object

资源组详细信息。

Id

string

资源组唯一标识。

Serverless_res_group_524257424564736_6831777003XXXXX

Name

string

资源组的名称。

common_resource_group

Remark

string

资源组的备注。

Create a common resource group for common tasks

PaymentType

string

资源组的付费类型,PrePaid 代表包年包月,PostPaid 代表按量付费 。

PrePaid

Status

string

查询的资源组状态:

  • Normal:正常(运行中/服务中)。

  • Stop:冻结(已到期)。

  • Deleted:删除(已释放/已销毁)。

  • Creating:创建中。

  • CreateFailed:创建失败。

  • Updating:更新中(扩容中/缩容中/变配中)。

  • UpdateFailed:更新失败(扩容失败/升级失败)。

  • Deleting:删除中(释放中/销毁中)。

  • DeleteFailed:删除失败(释放失败/销毁失败)。

  • Timeout:操作超时。

  • Freezed:冻结。

  • Starting:启动中。

枚举值:

  • Creating :

    创建中

  • Stop :

    冻结(已到期)

  • Timeout :

    操作超时

  • DeleteFailed :

    删除失败(释放失败/销毁失败)

  • UpdateFailed :

    更新失败(扩容失败/升级失败)

  • Updating :

    更新中(扩容中/缩容中/变配中)

  • Deleted :

    删除(已释放/已销毁)

  • Normal :

    正常(运行中/服务中)

  • Deleting :

    删除中(释放中/销毁中)

  • CreateFailed :

    创建失败

Normal

Spec

object

资源组规格。

Standard

string

规格详情。

2CU

Amount

integer

资源数量。

1

ResourceGroupType

string

资源组类型:

  • CommonV2:新版通用资源组;

  • ExclusiveDataIntegration:独享数据集成资源组;

  • ExclusiveScheduler:独享调度资源组;

  • ExclusiveDataService:独享数据服务资源组

枚举值:

  • CommonV2 :

    新版通用资源组

  • ExclusiveDataIntegration :

    独享数据集成资源组

  • ExclusiveScheduler :

    独享调度资源组

  • ExclusiveDataService :

    独享数据服务资源组

CommonV2

OrderInstanceId

string

资源组的订单实例 ID。

c442b330-3b10-4584-959e-736e4edXXXXX

CreateUser

string

创建该资源组的用户 ID。

11075500042XXXXX

CreateTime

integer

创建时间,为 64 位时间戳。

1727055811000

DefaultVpcId

string

通用资源组绑定的默认 VPC ID。

vpc-m2et4f3oc8msfbccXXXXX

DefaultVswitchId

string

通用资源组绑定的默认交换机 ID。

vsw-uf8usrhs7hjd9amsXXXXX

AliyunResourceGroupId

string

所属阿里云资源组 ID。

rg-aek2kqofrgXXXXX

AliyunResourceTags

array<object>

阿里云标签列表。

object

阿里云标签。

Key

string

标签 key。

key

Value

string

标签 value。

value

RequestId

string

请求的 ID,用于定位日志,排查问题。

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ResourceGroup": {
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
    "Name": "common_resource_group",
    "Remark": "Create a common resource group for common tasks",
    "PaymentType": "PrePaid",
    "Status": "Normal",
    "Spec": {
      "Standard": "2CU",
      "Amount": 1
    },
    "ResourceGroupType": "CommonV2",
    "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
    "CreateUser": "11075500042XXXXX",
    "CreateTime": 1727055811000,
    "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
    "DefaultVswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
    "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
    "AliyunResourceTags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

错误码

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

变更历史

更多信息,参考变更详情