Queries the usage of storage-related resources. The resources include the storage volume, storage duration, and outbound traffic.
Operation Description
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
vod:DescribeVodStorageData | Read |
|
| without |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
StartTime | string | Yes | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2019-02-01T14:00:00Z |
EndTime | string | Yes | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2019-02-01T15:00:00Z |
Region | string | No | The region where media assets are stored. If you do not set this parameter, the data in all regions is returned. You can specify multiple regions. Separate them with commas (,). Valid values:
| cn-shanghai |
StorageType | string | No | The storage type. Set the value to OSS. | OSS |
Storage | string | No | The name of the Object Storage Service (OSS) bucket. If you do not set this parameter, the data of all buckets is returned. You can specify multiple buckets. Separate them with commas (,). | bucket |
Response parameters
Example
Normal return example
JSON
Format
{
"DataInterval": "day",
"RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
"StorageData": [
{
"TimeStamp": "2019-02-01T15:00:00Z",
"StorageUtilization": "111111",
"NetworkOut": "111111"
}
]
}
Error codes
For a list of error codes, visit the API error center.
Common errors
The following table describes the common errors that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | The error message returned because the request was denied due to throttling. |
OperationDenied | Your account does not open VOD service yet. | 403 | The error message returned because ApsaraVideo VOD has not been activated for your Alibaba Cloud account. |
OperationDenied | Your VOD service is suspended. | 403 | The error message returned because ApsaraVideo VOD has been suspended for your Alibaba Cloud account. |
InvalidParameter | Invalid Parameter. | 400 | The error message returned because one or more parameters are invalid. |
InvalidParameterAliUid | Invalid Parameter AliUid. | 400 | The error message returned because the value of the AliUid parameter is invalid. |
InvalidParameterStartTime | Invalid Parameter StartTime. | 400 | The error message returned because the value of the StartTime parameter is invalid. |
InvalidParameterEndTime | Invalid Parameter EndTime. | 400 | The error message returned because the value of the EndTime parameter is invalid. |
InvalidTimeRange | StartTime and EndTime range should less than 1 month. | 400 | The error message returned because the time range that is specified by the StartTime and EndTime parameters exceeds 31 days. |
InvalidParameterRegion | Invalid Parameter Region. | 400 | The error message returned because the value of the Region parameter is invalid. |