Use GetOssUsageData to query storage and bandwidth usage - ENS

Operation description

The query and aggregation granularity of bandwidth and storage usage cannot exceed one day. Data aggregation is to collect the maximum values of usage data within a period of time.

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

ens:GetOssUsageData

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. The time must be in UTC. Format: 2010-01-21T09:50:23Z.	2022-01-11T00:00:00Z
EndTime	string	Yes	The end of the time range to query. The time must be in UTC. Format: 2010-01-21T09:50:23Z.	2022-01-12T00:00:00Z
Bucket	string	No	The name of the logical Object Storage Service (OSS) bucket.	ens-sink-bucketzyp1656903494
Period	string	No	The aggregation granularity. Unit: minutes. Default value: 5. Valid values: 5 to 1440.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2A8CCD48-14F9-0309-B957-7B1D74A8119D
UsageList	array<object>	The array of usage data.
	object
LanRxBw	integer	The inbound bandwidth over the internal network. Unit: bit/s.	37865147
LanTxBw	integer	The outbound bandwidth over the internal network. Unit: bit/s.	22012187890
Point	integer	The number of time points within a day.	144
PointTs	string	The point in time, in UTC. Format: 2010-01-21T09:50:23Z.	2022-01-12T00:00:00Z
StorageUsageByte	integer	The storage usage. Unit: bytes.	85462146217
WanRxBw	integer	The outbound bandwidth over the Internet. Unit: bit/s.	542155715
WanTxBw	integer	The outbound bandwidth over the Internet. Unit: bit/s.	547126175217

Examples

Success response

JSON format

{
  "RequestId": "2A8CCD48-14F9-0309-B957-7B1D74A8119D",
  "UsageList": [
    {
      "LanRxBw": 37865147,
      "LanTxBw": 22012187890,
      "Point": 144,
      "PointTs": "2022-01-12T00:00:00Z",
      "StorageUsageByte": 85462146217,
      "WanRxBw": 542155715,
      "WanTxBw": 547126175217
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ParamNotEnough	Insufficient parameters
400	ParamScopeError	Invalid parameter value
400	ParamTypeError	Invalid parameter type
400	SqlError	Databaseoperationerror
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.