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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vod:DescribeVodTieringStorageRetrievalData | none | *All Resources * |
| 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: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 |
Response parameters
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.