Tiered Storage Retrieval Data Overview via DescribeVodTieringStorageRetrievalData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Note

Currently, the service address supports only China (Shanghai).
If the query time interval is within 7 days, data at the hour granularity is returned. If the query time interval is greater than 7 days, data at the day granularity 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:DescribeVodTieringStorageRetrievalData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. The minimum data granularity is 5 minutes. If you leave this parameter empty, data of the last 24 hours is returned by default.	2023-06-02T10:20:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. The maximum time range is 31 days. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-06-02T11:20:00Z
Region	string	No	The storage region. By default, data of all regions is returned. You can specify multiple regions separated by commas (,).	cn-beijing
StorageClass	string	No	The storage class. Valid values: IA: Infrequent Access. Archive: Archive. ColdArchive: Cold Archive.	IA
AppId	string	No	The application ID.	app-1000000

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	25818875-5F78-4A13-BEF6-D73936****
RetrievalData	array<object>	The retrieval data.
	object	The retrieval data.
TimeStamp	string	The start time of the time interval. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2023-06-02T10:20:00Z
Region	string	The storage region.	cn-beijing
StorageClass	string	The media asset storage class.	IA
RetrievalData	integer	The retrieval data.	1234
CAStdRetrievalData	integer	The Cold Archive standard retrieval data.	123
CABulkRetrievalData	integer	The Cold Archive bulk retrieval data.	123
CAHighPriorRetrievalData	integer	The Cold Archive high-priority retrieval data.	123

The CAStdRetrievalData, CABulkRetrievalData, and CAHighPriorRetrievalData fields are returned only when the storage class is Cold Archive and the usage is not zero.

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A13-BEF6-D73936****",
  "RetrievalData": [
    {
      "TimeStamp": "2023-06-02T10:20:00Z\n",
      "Region": "cn-beijing",
      "StorageClass": "IA",
      "RetrievalData": 1234,
      "CAStdRetrievalData": 123,
      "CABulkRetrievalData": 123,
      "CAHighPriorRetrievalData": 123
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.