DescribeVodAIData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the statistics on video AI of different types, such as automated review and media fingerprinting.

Operation description

Note

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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-01T13: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:00: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: China (Shanghai) cn-beijing: China (Beijing) eu-central-1: Germany (Frankfurt) ap-southeast-1: Singapore	cn-beijing
AIType	string	No	The type of video AI. If you leave this parameter empty, statistics on video AI of all types are returned. Separate multiple types with commas (,). Valid values: AIVideoCensor: automated review AIVideoFPShot: media fingerprinting AIVideoTag: smart tagging	AIVideoCensor

Response parameters

Parameter	Type	Description	Example
	object
DataInterval	string	The time granularity at which the data was queried. Valid values: hour day	day
RequestId	string	The ID of the request.	C370DAF1-C838-4288-****-9A87633D248E
AIData	array<object>	The statistics on video AI.
	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.	2019-02-01T13:00:00Z
Data	array<object>	The statistics on video AI of each type.
	object
Name	string	The type of video AI. Valid values: AIVideoCensor: automated review AIVideoFPShot: media fingerprinting AIVideoTag: smart tagging	AIVideoCensor
Value	string	The processing duration. Unit: seconds.	111

Examples

Sample success responses

JSONformat

{
  "DataInterval": "day",
  "RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
  "AIData": {
    "AIDataItem": [
      {
        "TimeStamp": "2019-02-01T13:00:00Z",
        "Data": {
          "DataItem": [
            {
              "Name": "AIVideoCensor",
              "Value": "111"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

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.