Monitor Quota Consumption with QueryQuotaMetric API - MaxCompute

Queries the time series data of resource consumption for a quota.

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

odps:QueryQuotaMetric

list

*Quota

acs:odps:{#regionId}:{#accountId}:quota/{#metric}

None

Request syntax

POST /api/v1/observations/quota/{metric} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
metric	string	Yes	The name of the metric. Valid values: cpu and memory.	cpu

Request parameters

Parameter	Type	Required	Description	Example
startTime	integer	Yes	The start of the time range to query.	1735534322
endTime	integer	Yes	The end of the time range to query.	1735536322
strategy	string	No	The aggregation strategy for the data. The default value is max. Valid values: max and avg. Data is collected at one-minute intervals. If you query a long time range, the system may use an interval longer than one minute and aggregate the data. This parameter specifies how the data is aggregated.	max
body	object	No	The request body.
nickname	string	No	The nickname of the level-1 quota. This parameter is required.	os_sns_p
subQuotaNickname	string	No	The nickname of the level-2 quota.	os_sns
interval	integer	No	The fixed interval in seconds. If you leave this parameter empty, the system uses an automatic interval policy. Automatic interval policy: The interval is 60 seconds for a time range within 6 hours, 300 seconds for a time range within 24 hours, 900 seconds for a time range within 72 hours, and 1,800 seconds for a time range longer than 72 hours. Specified interval: Valid values are 60, 300, and 900. The query time range must be within 72 hours.	60
subMetric	string	No

Response elements

Element	Type	Description	Example
	object	PopResult<ObservationMetricDto>
requestId	string	The request ID.	0b87b7b316643495896551555e855b
httpCode	integer	The HTTP status code. 1xx: informational response. The request was received and is being processed. 2xx: success. The request was successfully received, understood, and accepted by the server. 3xx: redirection. The request was redirected. Further action needs to be taken to complete the request. 4xx: client error. The request contains incorrect request parameters or syntax, or specific request conditions cannot be met. 5xx: server error. The server failed to fulfill the request for other reasons.	200
errorCode	string	The error code.	success
errorMsg	string	The error message.	plan \"***\" does not exist
data	object	The returned data.
category	string	This parameter is not supported.	Not supported.
name	string	The name of the metric.	cpu
period	integer	The step size of the monitoring data.	60
metrics	array<object>	The metric values.
	array<object>	The metric value.
metric	object	The metadata of the metric.
	string	The metadata of the metric. unit: The unit of the metadata. If the metric is cpu, the unit is Core. If the metric is memory, the unit is GB. type: The type of the metadata. If the metric is cpu, the valid metadata types are totalMaxCpu, totalUsedCpu, adhocCpu, adhocUsedCpu, maxCpu, minCpu, requestCpu, usedCpu, elasticMaxCpu, and elasticUsedCpu. If the metric is memory, the valid metadata types are totalMaxMem, totalUsedMem, adhocMem, adhocUsedMem, elasticMaxMem, elasticUsedMem, maxMem, minMem, and usedMem.	totalUsedCpu
values	array	The time series data.
	array	An array of two elements. The first element is the timestamp and the second element is the value.
	number	An array of two elements. The first element is the timestamp and the second element is the value.	[1757571840,10]

Examples

Success response

JSON format

{
  "requestId": "0b87b7b316643495896551555e855b",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "category": "Not supported.",
    "name": "cpu",
    "period": 60,
    "metrics": [
      {
        "metric": {
          "key": "totalUsedCpu"
        },
        "values": [
          [
            0
          ]
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.