All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodPlayerDimensionData

    Document Center

    ApsaraVideo VOD:DescribeVodPlayerDimensionData

    Last Updated:Aug 25, 2025

    Queries the metadata of player dimensions.

    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:DescribeVodPlayerDimensionData

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    The application ID.

    app-1000000
    Dimension

    string

    Yes

    The dimension type. Valid values:

    • Os: operating system.

    • AppVersion: application version.

    • SdkVersion: SDK version.

    • Codec: encoding format.

    • VideoType: video format.

    • Network: network type.

    • Isp: carrier.

    • VideoDefinition: resolution.

    • Domain: domain name.

    • Country: country.

    • Province: province.

    • ErrorCode: error code.

    • IsHw: specifies whether to use hardware decoding.

    Os
    StartTime

    string

    No

    The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.

    Note

    • You can query data from the last year.

    • The maximum time range for a single query is 31 days.

    • The time range is a left-closed, right-open interval. The start time is included, but the end time is not.

    2025-06-24T00:55:06Z
    EndTime

    string

    No

    The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.

    2025-06-05T15:59:59Z
    Region

    string

    No

    The area to query. This parameter is used to filter the metadata of the `Province` and `Isp` dimensions. Valid values:

    • `ALL` (default): all areas.

    • `CN`: China.

    • `OVERSEAS`: areas outside China.

    ALL

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    25818875-5F78-4A*****F6-D7393642CA58
    DataList

    array

    The list of returned data.

    string

    The metadata of the dimension.

    Android

    Examples

    Success response

    JSON format

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "DataList": [
    "Android"
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Meter.ParamError Param Error:%s,Please Check Again. One or more parameters are invalid.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error. An internal error occurred.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again. An internal data source error occurred.
    403 Meter.AuthError Authentication Failed,Please Try Again. You do not have permissions to perform this operation.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again. The data is not prepared.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.