Todos os produtos
Search

Este produto

    ApsaraVideo VOD:DescribeVodMediaPlayData

    Central de documentação

    ApsaraVideo VOD:DescribeVodMediaPlayData

    Última atualização: Jul 21, 2026

    Obtém dados de reprodução de um arquivo de áudio ou vídeo em uma data especificada por ID de mídia (ID de áudio ou vídeo), incluindo o número de visitantes únicos, média de reproduções por usuário, total de reproduções, duração média de reprodução por usuário e duração total de reprodução.

    Descrição da operação

    • Atualmente, esta operação está disponível apenas na região China (Shanghai).

    • Apenas dados de reprodução coletados pelo ApsaraVideo Player SDK são suportados. Estatísticas de tráfego para streams somente de áudio não são suportadas.

    • Apenas dados dos últimos 30 dias podem ser consultados.

    Importante - Antes de chamar esta operação, certifique-se de que o ApsaraVideo Player SDK atenda às seguintes condições:
    • Android Player SDK ou iOS Player SDK

      • A versão do Player SDK é 5.4.9.2 ou posterior.

      • Uma licença para o Player SDK foi obtida e integrada. Para mais informações, consulte Gerenciamento de licenças.

      • O recurso de relatório de logs de rastreamento de eventos do Player SDK está ativado. Por padrão, esse recurso está ativado no ApsaraVideo Player SDK. Para mais informações, consulte Criar um player para Android e Criar um player para iOS.

    • Web Player SDK

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    vod:DescribeVodMediaPlayData

    none

    *全部资源

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    PlayDate

    string

    Não

    A data de reprodução. Unidade: dia. Formato: yyyyMMdd.

    Nota

    • Apenas consultas diárias são suportadas.

    • Apenas dados dos últimos 30 dias podem ser consultados.

    20240322
    TerminalType

    string

    Não

    O tipo de terminal do Player SDK. Especifique este parâmetro para realizar uma consulta filtrada dos dados de reprodução de todos os arquivos de áudio e vídeo por tipo de terminal. Valores válidos:

    • Native: Android Player SDK ou iOS Player SDK.

    • Web: Web Player SDK.

    Native.
    Os

    string

    Não

    O sistema operacional do dispositivo de reprodução. Especifique este parâmetro para realizar uma consulta filtrada dos dados de reprodução de todos os arquivos de áudio e vídeo por sistema operacional. Valores válidos:

    • Android

    • iOS

    • Windows

    • macOS

    • Linux

    Android.
    Region

    string

    Não

    A região do serviço. Especifique este parâmetro para realizar uma consulta filtrada dos dados de reprodução de todos os arquivos de áudio e vídeo por região do serviço. Valores válidos:

    • cn-beijing: China (Beijing)

    • cn-shanghai: China (Shanghai)

    • cn-shenzhen: China (Shenzhen)

    • ap-northeast-1: Japão (Tóquio)

    • ap-southeast-1: Singapura

    • ap-southeast-5: Indonésia (Jacarta)

    • eu-central-1: Alemanha (Frankfurt)

    cn-beijing.
    MediaId

    string

    Não

    O ID da mídia, que é o ID do áudio ou vídeo (VideoId). Especifique este parâmetro para consultar filtradamente os dados de reprodução de um arquivo de mídia específico. Apenas um ID de mídia pode ser especificado. Você pode obter o ID da mídia usando os seguintes métodos:

    • Para arquivos de áudio ou vídeo enviados através do console, faça login no console do ApsaraVideo VOD e escolha Arquivos de Mídia > Áudio/Vídeo para visualizar o ID do áudio ou vídeo.

    • Ao enviar um arquivo de áudio ou vídeo chamando a operação CreateUploadVideo, o ID do áudio ou vídeo é o valor do parâmetro de resposta VideoId.

    • Após o envio do arquivo de áudio ou vídeo, você pode chamar a operação SearchMedia para consultar filtradamente o ID do áudio ou vídeo, que é o valor do parâmetro de resposta VideoId.

    9ae2af636ca6c10412f44891fc****
    PageNo

    integer

    Sim

    O número da página dos dados a serem retornados. Especifique este parâmetro para definir a página a partir da qual os dados começam a ser retornados.

    1
    PageSize

    integer

    Sim

    O número de entradas por página. Especifique este parâmetro para definir o número de entradas exibidas em cada página. Valor máximo: 100.

    20
    OrderType

    string

    Não

    A ordem de classificação. Este parâmetro é usado em conjunto com o parâmetro OrderName. Especifique este parâmetro para classificar os dados retornados em ordem crescente ou decrescente por uma métrica especificada. Valores válidos:

    • ASC: ordem crescente. Os dados retornados são classificados do menor para o maior.

    • DESC: ordem decrescente. Os dados retornados são classificados do maior para o menor.

    ASC.
    OrderName

    string

    Não

    O nome da métrica. Este parâmetro é usado em conjunto com o parâmetro OrderType. Especifique este parâmetro para classificar os dados retornados em ordem crescente ou decrescente por uma métrica especificada. Valores válidos:

    • PlaySuccessVv: total de reproduções.

    • PlayPerVv: média de reproduções por usuário.

    • PlayDuration: duração total de reprodução.

    • PlayDurationPerUv: duração média de reprodução por usuário.

    PlaySuccessVv.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    RequestId

    string

    O ID da solicitação.

    25818875-5F78-4AF6-D7393642CA58****
    TotalCount

    integer

    O número total de entradas retornadas.

    1
    PageNo

    integer

    O número da página dos dados retornados.

    1
    PageSize

    integer

    O número de entradas por página.

    20
    QoeInfoList

    array<object>

    A lista de dados retornados.

    object

    Os detalhes dos dados retornados.

    VideoTitle

    string

    O título do arquivo de áudio ou vídeo.

    Título do vídeo do Alibaba Cloud VOD.
    VideoDuration

    number

    A duração do arquivo de áudio ou vídeo. Unidade: segundos.

    246
    MediaId

    string

    O ID da mídia, que é o ID do áudio ou vídeo (VideoId).

    9ae2af636ca6c10412f44891fc****
    DAU

    number

    O número de visitantes únicos para o arquivo de áudio ou vídeo.

    5
    PlaySuccessVv

    number

    O número total de reproduções para o arquivo de áudio ou vídeo.

    20
    PlayDurationPerUv

    number

    A duração média de reprodução por usuário para o arquivo de áudio ou vídeo. Unidade: segundos.

    120
    PlayDuration

    number

    A duração total de reprodução para o arquivo de áudio ou vídeo. Unidade: segundos.

    2400
    PlayPerVv

    number

    O número médio de reproduções por usuário para o arquivo de áudio ou vídeo.

    4

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "TotalCount": 1,
  "PageNo": 1,
  "PageSize": 20,
  "QoeInfoList": [
    {
      "VideoTitle": "Alibaba Cloud VOD video title",
      "VideoDuration": 246,
      "MediaId": "9ae2af636ca6c10412f44891fc****",
      "DAU": 5,
      "PlaySuccessVv": 20,
      "PlayDurationPerUv": 120,
      "PlayDuration": 2400,
      "PlayPerVv": 4
    }
  ]
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 Meter.ParamError Param Error:%s,Please Check Again.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again.
    403 Meter.AuthError Authentication Failed,Please Try Again.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.