QueryStorageMetric - MaxCompute - Alibaba Cloud Documentation Center

Queries time-series metrics of data storage.

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

list

*Storage

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
metric	string	Yes	The name of the metric. Valid value: summary	summary

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
body	object	No	The request body.
projectList	array	No	The names of the projects.
	string	No	The project name.	projectA
typeList	array	No	The storage class. Valid values include the following: totalStorage longTermStorage lowFreqStorage standardStorage recycleBinStorage
	string	No	The storage class.	totalStorage

Response elements

Element	Type	Description	Example
	object	PopResult<ObservationMetricDto>
requestId	string	The request ID.	0be3e0bb16654558425251398e27a9
httpCode	integer	The HTTP status code. 1xx: Informational - 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 is needed to complete the request. 4xx: Client error - The request contains incorrect parameters or syntax, or cannot be fulfilled. 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.	0A3B1FD2006A24C8D8BE65CDAC028298
data	object	The data returned.
category	string	The category of the metric.	storage
name	string	The name of the metric.	summary
period	integer	The step size of the monitoring data.	3600
metrics	array<object>	The metric values.
	object	The metric values.
metric	object	The metadata of the metric.
	string	The metric information. This includes: unit type	"unit":"GB" "type":"standardStorage"
values	array	The time series data.
	array	An array of two elements: a timestamp and a value.
	number	An array of two elements: a timestamp and a value.	174853440, 2.345719

Examples

Success response

JSON format

{
  "requestId": "0be3e0bb16654558425251398e27a9",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1FD2006A24C8D8BE65CDAC028298",
  "data": {
    "category": "storage",
    "name": "summary",
    "period": 3600,
    "metrics": [
      {
        "metric": {
          "key": "\"unit\":\"GB\"\t\t\t\t\t\t\"type\":\"standardStorage\""
        },
        "values": [
          [
            0
          ]
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.