Queries the metric data of a resource group.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 |
| Period | string | No | The statistical period for monitoring data. Value: A multiple of 60. Unit: Seconds. Default: 60. | 60 |
| BeginTime | long | 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 | long | 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 parameters
Examples
Sample success responses
JSONformat
{
"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
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-04 | Add Operation | View Change Details |