Queries the transcoding statistics.
Operation description
-
This operation is available only in the China (Shanghai) region.
-
If the time range to query is less than or equal to seven days, the system returns the statistics collected on an hourly basis. If the time range to query is greater than seven days, the system returns the statistics collected on a daily basis. The maximum time range that you can specify to query 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:DescribeVodTranscodeData | get | *All Resources * |
| none |
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-01T15: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:59: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 (,). Valid values:
| cn-shanghai |
| Interval | string | No | The interval at which you want to query data. Valid values:
| day |
| Storage | string | No | The name of the Object Storage Service (OSS) bucket. If you leave this parameter empty, data of all buckets is returned. Separate multiple bucket names with commas (,). | bucket01 |
| Specification | string | No | The transcoding specification. If you leave this parameter empty, data of all transcoding specifications is returned. Separate multiple transcoding specifications with commas (,). Valid values:
| Audio |
| AppId | string | No | The ID of the application. You can specify this parameter to query the transcoding statistics of a specific application. By default, the transcoding statistics of all applications is returned. You can obtain the application ID from the | app-1000001 |
Response parameters
Examples
Sample success responses
JSONformat
{
"DataInterval": "day",
"RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
"TranscodeData": {
"TranscodeDataItem": [
{
"TimeStamp": "2019-02-01T16:00:00Z",
"Data": {
"DataItem": [
{
"Name": "H264.SD",
"Value": "111"
}
]
}
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-04-02 | The Error code has changed | View Change Details |
| 2024-03-26 | The Error code has changed. The request parameters of the API has changed | View Change Details |
Common errors
The following table describes the error codes 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 is not activated for your Alibaba Cloud account. |
| OperationDenied | Your VOD service is suspended. | 403 | The error message returned because ApsaraVideo VOD is 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. |