All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodAIData

Last Updated:May 11, 2024

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.

    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:DescribeVodAIDataRead
    • 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-01T13: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:00: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-beijing
    AITypestringNo

    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

    ParameterTypeDescriptionExample
    object
    DataIntervalstring

    The time granularity at which the data was queried. Valid values:

    • hour
    • day
    day
    RequestIdstring

    The ID of the request.

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

    The statistics on video AI.

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

    The statistics on video AI of each type.

    Namestring

    The type of video AI. Valid values:

    • AIVideoCensor: automated review
    • AIVideoFPShot: media fingerprinting
    • AIVideoTag: smart tagging
    AIVideoCensor
    Valuestring

    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 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.