DescribeVodTieringStorageRetrievalData - ApsaraVideo VOD

Queries the data retrieval from tiered storage.

Operation description

This operation is available only in the China (Shanghai) region.
If you specify a time range within 7 days, the request returns the data based on hours. If you specify a time range longer than 7 days, the request returns the data based on days. The maximum time range is 31 days.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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:mm:ssZ format. The time must be in UTC. The minimum time range is 5 minutes. If you leave this parameter empty, data in the last 24 hours is queried.	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 time range cannot exceed 31 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-06-02T11:20:00Z
Region	string	No	The region in which you want to query data. If you leave this parameter empty, data in all regions is returned. Separate multiple regions with commas (,).	cn-beijing
StorageClass	string	No	The storage type. Valid values: IA Archive ColdArchive	IA

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	25818875-5F78-4A13-BEF6-D73936****
RetrievalData	array<object>	The data retrieval information.
	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.	2023-06-02T10:20:00Z
Region	string	The storage region.	cn-beijing
StorageClass	string	The storage type.	IA
RetrievalData	long	The data retrieval information.	1234
CAStdRetrievalData	long	The retrieved Cold Archive data in the standard mode.	123
CABulkRetrievalData	long	The retrieved Cold Archive data in the bulk mode.	123
CAHighPriorRetrievalData	long	The retrieved Cold Archive data in the expedited mode.	123

The CAStdRetrievalData, CABulkRetrievalData, and CAHighPriorRetrievalData parameters are returned only when Cold Archive data is retrieved within the specified period of time.

Examples

Sample success responses

JSONformat

{
  "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

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