All Products
Search
Document Center

ENS:GetOssUsageData

Last Updated:Mar 12, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

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
EndTimestringYes

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
BucketstringNo

The name of the logical Object Storage Service (OSS) bucket.

ens-sink-bucketzyp1656903494
PeriodstringNo

The aggregation granularity. Unit: minutes.

Default value: 5. Valid values: 5 to 1440.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2A8CCD48-14F9-0309-B957-7B1D74A8119D
UsageListobject []

The array of usage data.

LanRxBwlong

The inbound bandwidth over the internal network. Unit: bit/s.

37865147
LanTxBwlong

The outbound bandwidth over the internal network. Unit: bit/s.

22012187890
Pointlong

The number of time points within a day.

144
PointTsstring

The point in time, in UTC. Format: 2010-01-21T09:50:23Z.

2022-01-12T00:00:00Z
StorageUsageBytelong

The storage usage. Unit: bytes.

85462146217
WanRxBwlong

The outbound bandwidth over the Internet. Unit: bit/s.

542155715
WanTxBwlong

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 codeError codeError message
400ParamNotEnough
400ParamScopeError
400ParamTypeError
400SqlError
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
2024-01-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400