GetOssUsageData - ENS - Alibaba Cloud Documentation Center

Queries the storage and bandwidth usage within a specific time range.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:GetOssUsageData		All Resources *	none	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	2A8CCD48-14F9-0309-B957-7B1D74A8119D
UsageList	array<object>	The array of usage data.
	object
LanRxBw	long	The inbound bandwidth over the internal network. Unit: bit/s.	37865147
LanTxBw	long	The outbound bandwidth over the internal network. Unit: bit/s.	22012187890
Point	long	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	long	The storage usage. Unit: bytes.	85462146217
WanRxBw	long	The outbound bandwidth over the Internet. Unit: bit/s.	542155715
WanTxBw	long	The outbound bandwidth over the Internet. Unit: bit/s.	547126175217

Examples

Sample success responses

JSONformat

{
  "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
400	ParamScopeError
400	ParamTypeError
400	SqlError
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed	View Change Details