Query Resource Group Metric Data via API - DataWorks - Alibaba Cloud - DataWorks

Queries the metric data of a resource group.

Operation description

DataWorks Basic Edition or a more advanced edition is required to use this feature.
Make sure that the service-linked role AliyunServiceRoleForDataWorks has been created before you call this operation.
This operation applies only to serverless resource groups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListResourceGroupMetricData

get

*DwResourceGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	Yes	The unique identifier for the general-purpose resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
MetricName	string	Yes	The metric name. Valid values: CUSpec: Maximum CU capacity of the resource group, in CUs. CUUsage: CU usage of the resource group, in CUs. CUUtilization: CU utilization of the resource group, in %. SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots. SlotUsage: Used concurrency for resource group scheduling, in slots. SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs. SchedulerCUUsage: CU usage for data computing, in CUs. SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs. DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs. DataIntegrationCUUsage: CU usage for Data Integration, in CUs. DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs. DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs. DataServiceCUUsage: CU usage for DataService Studio, in CUs. DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs. ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs. ServerIdeCUUsage: CU usage for personal development environment, in CUs. ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.	CUSpec
Period	string	No	The statistical period for monitoring data. Value: A multiple of 60. Unit: Seconds. Default: 60.	60
BeginTime	integer	No	The start time. Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970). The interval between BeginTime and EndTime must be less than or equal to 31 days. Default: The current time minus 2 hours, expressed as a millisecond Unix timestamp.	1593950832000
EndTime	integer	No	The end time. Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970). The interval between BeginTime and EndTime must be less than or equal to 31 days. Default: The current time, expressed as a millisecond Unix timestamp.	1750176000000
NextToken	string	No	The pagination cursor. Note If this parameter is not set, the first page of data is retrieved. If a value is returned for this parameter, it indicates that there is a next page. You can use the returned NextToken as a parameter to request the next page of data until it returns Null, which means all data has been retrieved.	FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM
Length	integer	No	The number of records to display on each page for paginated queries. Note The maximum value of Length for a single request is 1440.	100

Response elements

Element	Type	Description	Example
	object	The returned result.
Success	boolean	Indicates whether the request was successful.	true
MetricData	object	Monitoring metric data.
Id	string	The unique identifier for the resource group.	Serverless_res_group_524257424564736_6831777003XXXXX
MetricName	string	The metric name. Valid values: CUSpec: Maximum CU capacity of the resource group, in CUs. CUUsage: CU usage of the resource group, in CUs. CUUtilization: CU utilization of the resource group, in %. SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots. SlotUsage: Used concurrency for resource group scheduling, in slots. SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs. SchedulerCUUsage: CU usage for data computing, in CUs. SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs. DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs. DataIntegrationCUUsage: CU usage for Data Integration, in CUs. DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs. DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs. DataServiceCUUsage: CU usage for DataService Studio, in CUs. DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs. ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs. ServerIdeCUUsage: CU usage for personal development environment, in CUs. ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.	CUSpec
NextToken	string	The pagination cursor.	tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl
Metrics	array<object>	The list of metric data.
	object	The metric data.
Value	number	The value of the metric data.	1.0
Timestamp	integer	The timestamp.	1761184929633
RequestId	string	The request ID, used for locating logs and troubleshooting.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Success": true,
  "MetricData": {
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX\n",
    "MetricName": "CUSpec",
    "NextToken": "tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl",
    "Metrics": [
      {
        "Value": 1,
        "Timestamp": 1761184929633
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.