GetStorageSizeSummary - MaxCompute - Alibaba Cloud Documentation Center

Retrieves a summary of 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:GetStorageSizeSummary

get

*All Resource

*

None

Request syntax

GET /api/v1/observations/analysis/storage/size HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID.	483212237127906
region	string	No	The region ID.	cn-chengdu
date	string	No	The date of statistics. The value is at the day level. The format is YYYYMMdd.	20241205

Response elements

Element	Type	Description	Example
	object	PopResult<ObservationStorageSummaryInfo>
requestId	string	The request ID.	0be3e0aa16667684362147582e038f
httpCode	integer	Indicates whether the business is successful. If this parameter is not empty and the value is not 200, the business fails.	200
errorCode	string	The business error code or an empty value. If success is false, a business error code is returned. If success is true, an empty value is returned.	success
errorMsg	string	The description of the error.	this quota is not exist.
data	object	The returned data.
date	string	The date of statistics.	20241205
timestamp	integer	The timestamp of the last data update.	1749090705919
value	object	The storage metrics. It includes: lowFreqStorage standardStorage longTermStorage totalStorage
	number	The usage of the storage metric.	110.438238
unit	object	The unit of the storage metric usage. It includes: lowFreqStorage standardStorage longTermStorage totalStorage
	string	The unit of the storage metric usage.	TB

Examples

Success response

JSON format

{
  "requestId": "0be3e0aa16667684362147582e038f",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "this quota is not exist.",
  "data": {
    "date": "20241205",
    "timestamp": 1749090705919,
    "value": {
      "key": 110.438238
    },
    "unit": {
      "key": "TB"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.