SumStorageMetricsByDate - MaxCompute - Alibaba Cloud Documentation Center

Retrieves the storage information for each category or project on a specified date.

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

*All Resource

*

None

Request syntax

POST /api/v1/storageMetrics/sumByDate HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
userId	string	No	The user UID.	12345
region	string	No	The region ID.	cn-hangzhou
projectNames	array	No	The project names.
	string	No	The project name.	prj
startDate	integer	No	The start date. The value is a millisecond-level timestamp. This parameter is required.	1715393576201
endDate	integer	No	The end date. The value is a millisecond-level timestamp. This parameter is required.	1718590596556
statsType	string	No	The type of storage usage statistics. This parameter is required. Valid values: PROJECT STORAGE_TYPE	PROJECT

Response parameters

Parameter	Type	Description	Example
	object	PopResult<List>
requestId	string	The request ID.	0abb781a17411408145995819e0dae
httpCode	integer	The HTTP status code. 1xx: Informational response. The request has been received and is being processed. 2xx: Success. The action was successfully received, understood, and accepted by the server. 3xx: Redirection. The request was redirected, and further action is required to complete the request. 4xx: Client error. The request contains invalid 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.	this quota is not exist.
data	array<object>	The returned data.
	object	The data returned for the request.
storageType	string	The storage class. Valid values: Storage. Standard storage. LowFreqStorage. IA storage class. ColdStorage. Archive storage.	Storage
dateTime	string	The date of the statistics. The format is yyyyMMdd.	20250719
usage	string	The total storage usage.	329.503338
unit	string	The unit of the total storage usage.	GB
itemStorageMetrics	array<object>	A list of storage usage for the specified type.
	object	The storage usage for the specified type.
itemName	string	If the specified type is PROJECT, this parameter indicates the project name. If the specified type is STORAGE_TYPE, this parameter indicates the storage class.	prj
usage	string	The storage usage.	300.560392
percentage	number	The percentage of the storage usage.	91.22

Examples

Success response

JSON format

{
  "requestId": "0abb781a17411408145995819e0dae",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "this quota is not exist.",
  "data": [
    {
      "storageType": "Storage",
      "dateTime": "20250719",
      "usage": "329.503338",
      "unit": "GB",
      "itemStorageMetrics": [
        {
          "itemName": "prj",
          "usage": "300.560392",
          "percentage": 91.22
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.