GetStorageAmountSummary - MaxCompute - Alibaba Cloud Documentation Center

Retrieves a summary of the total storage amount.

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 support 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:GetStorageAmountSummary

get

*All Resource

*

None

Request syntax

GET /api/v1/observations/analysis/storage/amount 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 Management > Tenant Properties in the navigation pane on the left to view the tenant ID.	478403690625249
region	string	No	The region ID.	cn-shanghai
date	string	No	The date for which the statistics are collected. The statistics are collected on a daily basis. Specify the date in the YYYYMMDD format.	20241205

Response parameters

Parameter	Type	Description	Example
	object	PopResult<ObservationStorageSummaryInfo>
requestId	string	The request ID.	688003E1-D1B4-5468-957E-2FFB3AC8D79B
httpCode	integer	Indicates whether the business is successful. If this parameter is not empty and the value is not 200, the business processing failed.	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 error message.	this quota is not exist.
data	object	The returned data.
date	string	The date of the statistics.	20241205
timestamp	integer	The timestamp. This API does not return this parameter.	-
value	object	The storage metrics. The metrics include the following: projectAmount schemaAmount tableAmount partitionAmount
	integer	The storage amount value.	16
unit	object	The unit of the storage metrics. This API does not return this parameter.
	string	This API does not return this parameter.	-

Examples

Success response

JSON format

{
  "requestId": "688003E1-D1B4-5468-957E-2FFB3AC8D79B",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "this quota is not exist.",
  "data": {
    "date": "20241205",
    "timestamp": 0,
    "value": {
      "key": 16
    },
    "unit": {
      "key": "-"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.