All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodTranscodeData

Last Updated:May 22, 2024

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

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

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeVodTranscodeDataRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

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
EndTimestringYes

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
RegionstringNo

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: China (Shanghai)
  • cn-beijing: China (Beijing)
  • eu-central-1: Germany (Frankfurt)
  • ap-southeast-1: Singapore
cn-shanghai
IntervalstringNo

The interval at which you want to query data. Valid values:

  • day: days
  • hour: hours
day
StoragestringNo

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
SpecificationstringNo

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: audio transcoding
  • Segmentation: container format conversion
  • H264.LD, H264.SD, H264.HD, H264.2K, H264.4K, and more
Audio
AppIdstringNo

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 AppId parameter in the response to the CreateAppInfo operation.

app-1000001

Response parameters

ParameterTypeDescriptionExample
object
DataIntervalstring

The interval at which the data was queried. Valid values:

  • hour
  • day
day
RequestIdstring

The ID of the request.

C370DAF1-C838-4288-****-9A87633D248E
TranscodeDataobject []

The transcoding statistics returned.

TimeStampstring

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-01T16:00:00Z
Dataobject []

The statistics on transcoding of different specifications.

Namestring

The transcoding specification. Valid values:

  • Audio: audio transcoding
  • Segmentation: container format conversion
  • H264.LD, H264.SD, H264.HD, H264.2K, H264.4K, and more
H264.SD
Valuestring

The transcoding duration. Unit: seconds.

111

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 timeSummary of changesOperation
2024-04-02The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2024-03-26The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: AppId

Common errors

The following table describes the error codes that this operation can return.

Error codeError messageHTTP status codeDescription
ThrottlingRequest was denied due to request throttling.503The error message returned because the request was denied due to throttling.
OperationDeniedYour account does not open VOD service yet.403The error message returned because ApsaraVideo VOD is not activated for your Alibaba Cloud account.
OperationDeniedYour VOD service is suspended.403The error message returned because ApsaraVideo VOD is suspended for your Alibaba Cloud account.
InvalidParameterInvalid Parameter.400The error message returned because one or more parameters are invalid.
InvalidParameterAliUidInvalid Parameter AliUid.400The error message returned because the value of the AliUid parameter is invalid.
InvalidParameterStartTimeInvalid Parameter StartTime.400The error message returned because the value of the StartTime parameter is invalid.
InvalidParameterEndTimeInvalid Parameter EndTime.400The error message returned because the value of the EndTime parameter is invalid.
InvalidTimeRangeStartTime and EndTime range should less than 1 month.400The error message returned because the time range that is specified by the StartTime and EndTime parameters exceeds 31 days.
InvalidParameterRegionInvalid Parameter Region.400The error message returned because the value of the Region parameter is invalid.