Use DescribeVodStorageData to query storage usage and outbound traffic - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Currently, the service address supports only China (Shanghai).
If the interval between the start time and end time is within 7 days, hourly data is returned. If the interval is greater than 7 days, daily data is returned. The maximum interval is 31 days.

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

vod:DescribeVodStorageData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (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 yyyy-MM-ddTHH:mm:ssZ format (UTC).	2019-02-01T15:00:00Z
Region	string	No	The storage region. By default, data of all regions is returned. You can specify multiple regions separated by commas (,). Valid values: cn-shanghai: Shanghai. cn-beijing: Beijing. eu-central-1: Germany. ap-southeast-1: Singapore.	cn-shanghai
StorageType	string	No	The storage type. Set the value to OSS.	OSS
Storage	string	No	The storage name (Alibaba Cloud OSS bucket name). By default, data of all storage buckets is returned. You can specify multiple storage names separated by commas (,).	bucket
AppId	string	No	The application ID. If you have activated the multi-application feature, you can specify this parameter to query the storage usage of a specific application. If you do not specify this parameter, the total storage usage of all applications is returned. You can obtain the value of this parameter from the AppId response parameter of the CreateAppInfo operation. For more information, see Multi-application.	app-1000000

Response elements

Element	Type	Description	Example
	object
DataInterval	string	The time granularity of the returned data. Valid values: hour: hourly data. day: daily data.	day
RequestId	string	The request ID.	C370DAF1-C838-4288-****-9A87633D248E
StorageData	object
StorageDataItem	array<object>	The storage usage data.
	object
TimeStamp	string	The timestamp of the returned data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-02-01T15:00:00Z
StorageUtilization	string	The detailed usage data of storage-related resources. Unit: bytes.	111111
NetworkOut	string	The outbound traffic. Unit: bytes. The outbound traffic is generated when videos are directly downloaded or played from OSS buckets without Alibaba Cloud CDN acceleration.	111111

Examples

Success response

JSON format

{
  "DataInterval": "day",
  "RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
  "StorageData": {
    "StorageDataItem": [
      {
        "TimeStamp": "2019-02-01T15:00:00Z",
        "StorageUtilization": "111111",
        "NetworkOut": "111111"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidParameterType	The specified Type is invalid.	The Type parameter is invalid. Modify the value of the Type parameter based on the documentation.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span based on the documentation.
400	InvalidParameter	Invalid input parameter.	Input parameter error.
400	InvalidTime.Malformed	The specified Time is malformed.	The time format is incorrect. Modify the format of the input parameter based on the documentation.
400	InvalidParameterInterval	The specified Interval is invalid.	The specified time granularity is invalid. Specify the time granularity based on the requirements described in the API documentation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.