Call DescribeVodAIData to query video AI statistics - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries usage data of AI processing services such as automated review and media fingerprint.

Operation description

Currently, the service address supports only China (Shanghai).
If the interval between the start time and end time is within 7 days, hourly data is returned. If the interval is greater than 7 days, daily data is returned. The maximum interval is 31 days.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DescribeVodAIData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start of the time range to query. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format (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 `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2019-02-01T15:00:00Z
Region	string	No	The storage region. By default, data in all regions is returned. You can specify multiple regions separated by commas (,). Valid values: cn-shanghai: Shanghai. cn-beijing: Beijing. eu-central-1: Germany. ap-southeast-1: Singapore.	cn-beijing
AIType	string	No	The AI type. By default, all types are returned. You can specify multiple types separated by commas (,). Valid values: AIVideoCensor: automated review. AIVideoFPShot: media fingerprint. AIVideoTag: smart tagging.	AIVideoCensor

Response elements

Element	Type	Description	Example
	object
DataInterval	string	The time granularity of the returned data. Valid values: hour: hourly data. day: daily data.	day
RequestId	string	The request ID.	C370DAF1-C838-4288-****-9A87633D248E
AIData	object
AIDataItem	array<object>	The AI processing usage data.
	array<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	object
DataItem	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

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	InvalidParameter.
400	InvalidParameterStartTime	Invalid Parameter StartTime.	The StartTime parameter is invalid.
400	InvalidParameterEndTime	Invalid Parameter EndTime.
400	InvalidTimeRange	Invalid StartTime and EndTime range.	The time frame is not legal.
400	InvalidParameterInterval	Invalid Parameter interval.
400	InvalidParameterRegion	Invalid Parameter Region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.