GetStorageSummaryCompared - MaxCompute - Alibaba Cloud Documentation Center

Retrieves the year-on-year (YoY) change in storage usage.

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:GetStorageSummaryCompared

get

*All Resource

*

None

Request syntax

GET /api/v1/observations/analysis/storage/{type}/compared HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID. You can log on to the MaxCompute console and choose Tenant Property in the navigation pane on the left to view the tenant ID.	483212237127906
region	string	No	The region ID.	cn-beijing
beginDate	string	Yes	The start date.	20250601
endDate	string	Yes	The end date.	20250604
type	string	Yes	The storage metric for comparison. Valid values: size amount	size
projects	array	No	The list of projects.
	string	No	The project name.	prj

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The request ID.	0bc3b4b016674434996033675e71ee
httpCode	integer	The HTTP status code. 1xx: informational response. The request is received and is being processed. 2xx: success. The request is successfully received, understood, and accepted by the server. 3xx: redirection. The request is redirected. You must take further action to complete the request. 4xx: client error. The request contains invalid parameters or syntax, or fails to meet specific conditions. 5xx: server error. The server cannot 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 data returned.
beginDate	string	The start date.	20250601
endDate	string	The end date.	20250604
rate	object	The year-on-year (YoY) change rate of the storage usage from the start date to the end date. Valid values: lowFreqStorageRate totalStorageRate standardStorageRate longTermStorageRate
	number	The YoY change rate.	0.06365304264561006
value	object	The change in the storage usage from the start date to the end date. Valid values: lowFreqStorage totalStorage standardStorage longTermStorage
	number	The change value.	-13.437440000000606
unit	object	The unit of the change in the storage usage from the start date to the end date. Valid values: lowFreqStorageUnit totalStorageUnit standardStorageUnit longTermStorageUnit
	string	The unit of the change value.	GB

Examples

Success response

JSON format

{
  "requestId": "0bc3b4b016674434996033675e71ee",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "beginDate": "20250601",
    "endDate": "20250604",
    "rate": {
      "key": 0.06365304264561006
    },
    "value": {
      "key": -13.437440000000606
    },
    "unit": {
      "key": "GB"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.