All Products
Search
Document Center

ENS:GetOssUsageData

Last Updated:Nov 05, 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ens:GetOssUsageData
  • All Resources
    *
    none
none

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
UsageListarray<object>

The array of usage data.

UsageListobject
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 changedView Change Details