Todos os produtos
Search
Central de documentação

ApsaraVideo VOD:Parâmetros de solicitação

Última atualização: Jun 27, 2026

Este tópico descreve os seguintes parâmetros de solicitação das operações da API do ApsaraVideo VOD: PlayConfig, ReAuthInfo, UserData, SpriteSnapshotConfig e EncryptConfig. Também fornece exemplos de configuração desses parâmetros.

PlayConfig: defina as configurações personalizadas para reprodução de mídia

Descrição

Este parâmetro especifica as configurações personalizadas para a reprodução de mídia. O valor é uma string JSON. Você pode definir configurações de reprodução para um domínio de streaming específico. A tabela a seguir descreve os campos em PlayConfig.

Campo

Tipo

Obrigatório

Descrição

PlayDomain

String

Não

O domínio de streaming. Se você configurar vários nomes de domínio de origem, especifique um nome de domínio para reproduzir o vídeo. Caso o domínio de streaming especificado não exista, a URL de streaming retornará o domínio de streaming padrão configurado para o endereço de armazenamento do vídeo. Exemplo: "vod.test_domain".

XForwardedFor

String

Não

O endereço IP de origem do cliente que inicia a solicitação. Este campo verifica se a solicitação partiu de um endereço IP adicionado a um grupo de segurança de revisão. Para obter mais informações, consulte Visualização de endereço IP de segurança. O ApsaraVideo VOD obtém o endereço IP do cliente com base neste campo após a solicitação passar por vários servidores proxy. Para aumentar a segurança dos dados, o endereço IP do cliente é criptografado usando AES/ECB/PKCS5Padding. Para obter a chave de criptografia, abra um ticket.

Exemplo: yqCD7Fp1uqChoVj/sl/p5Q==.

PreviewTime

String

Não

A duração da visualização. Unidade: segundos. O valor mínimo é 1 e o máximo corresponde à duração total do vídeo. Se este campo ficar vazio, todo o vídeo estará disponível para visualização. Para saber mais sobre como ativar o recurso de visualização, consulte Configurar o recurso de visualização.

MtsHlsUriToken

String

Não

O MtsHlsUriToken gerado por um serviço de emissão de tokens. Use este campo para descriptografar e reproduzir vídeos protegidos com criptografia HTTP Live Streaming (HLS), evitando assim o roubo de chaves de descriptografia. Para obter mais informações, consulte Criptografia HLS.

EncryptType

String

Não

O tipo de criptografia. Defina este campo para reproduzir vídeos sem criptografia ou vídeos com um tipo específico de proteção. Valores válidos:

  • Unencrypted: sem criptografia

  • AliyunVoDEncryption: criptografia proprietária da Alibaba Cloud

  • HLSEncryption: criptografia HLS

Nota

Para mais detalhes sobre as URLs de reprodução de streams criptografados, consulte Obter uma URL de reprodução.

StorageClass

String

Não

A classe de armazenamento do ativo de mídia. Utilize este campo para filtrar os streams de reprodução de uma classe de armazenamento específica. Valores válidos:

  • Por padrão, este campo permanece vazio. Uma string vazia indica ausência de filtro. Se a classe de armazenamento do arquivo de áudio ou vídeo for Standard, todas as URLs de reprodução dos streams serão retornadas. Caso a classe de armazenamento dos recursos de mídia não seja Standard, nenhuma URL de reprodução será devolvida. Quando a classe de armazenamento do arquivo source não for Standard, apenas as URLs de reprodução dos streams transcodificados serão retornadas, excluindo a URL do stream de qualidade original.

  • All: todas as classes de armazenamento.

  • Standard: todos os recursos de mídia armazenados como objetos Standard.

  • IA: todos os recursos de mídia armazenados como objetos IA.

  • Archive: todos os recursos de mídia armazenados como objetos Archive.

  • ColdArchive: todos os recursos de mídia armazenados como objetos Cold Archive.

  • SourceIA: apenas os arquivos source são objetos IA.

  • SourceArchive: apenas os arquivos source são objetos Archive.

  • SourceColdArchive: apenas os arquivos source são objetos Cold Archive.

  • Changing: a classe de armazenamento dos recursos de mídia está em processo de alteração.

  • SourceChanging: a classe de armazenamento do arquivo source está em processo de alteração.

Código de exemplo

PlayConfig={
  "PlayDomain": "vod.test_domain",
  "XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
  "PreviewTime": "20",
  "MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
  "StorageClass": "Standard"
}              

ReAuthInfo: defina as configurações de reautenticação do CDN

Descrição

Este campo especifica as configurações de reautenticação do CDN para reprodução de mídia. O valor é uma string JSON. Após ativar o recurso de reautenticação do CDN, utilize este campo para definir os campos uid e rand na assinatura da URL. A tabela abaixo detalha os campos presentes em ReAuthInfo.

Campo

Tipo

Obrigatório

Descrição

uid

String

Não

Campo adicional. Geralmente definido como 0, mas aceita valores personalizados.

rand

String

Não

Número aleatório. Na maioria dos casos, assume o valor 0. Para gerar uma URL diferente a cada solicitação de vídeo, utilize o UUID como número aleatório.

Código de exemplo

ReAuthInfo={
  "uid": "12345",
  "rand": "abckljd"
}

UserData: defina as configurações personalizadas para upload de mídia

Descrição

Este campo determina as configurações personalizadas para o upload de mídia, incluindo as configurações de callback para notificações de eventos. O valor deve ser uma string JSON.

A tabela a seguir lista os campos contidos em UserData.

Campo

Tipo

Obrigatório

Descrição

MessageCallback

String

Não

Configurações de callback para notificações de eventos, representadas por um objeto JSON. Ao preencher este campo, as configurações especificadas terão prioridade; caso contrário, o sistema aplicará as configurações padrão de callback. Para mais informações, consulte Especificar múltiplas URLs de callback.

Os parâmetros são descritos abaixo:

  • CallbackType: método de callback. Valores válidos: http e mns.

  • CallbackURL: URL de callback HTTP. Obrigatório quando CallbackType for definido como http.

  • MNSQueueName: nome da fila do Message Service (MNS). Necessário se CallbackType for igual a mns.

  • MSSEndpoint: endpoint da fila MNS. Exigido quando CallbackType estiver configurado como mns.

Exemplos:

  • Callback HTTP: {"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}

  • Callback MNS: {"CallbackType":"mns","MNSQueueName":"vod-callback-bj","MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com"}

Extend

String

Não

Campo estendido personalizado, transmitido de forma transparente durante os callbacks de eventos. Aceita até 512 bytes e deve ser um objeto JSON.

Nota

Recomenda-se converter valores com caracteres especiais, como cifrões ($), barras (/) ou barras invertidas (\), para strings codificadas em Base64.

AccelerateConfig

String

Não

Configurações para aceleração de upload, estruturadas como objeto JSON. Exemplo: {"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"}. Type indica o método de aceleração, aceitando apenas o valor oss. Domain representa o nome de domínio acelerado, disponível em Regiões e endpoints. O protocolo HTTPS é utilizado por padrão.

Nota

O recurso de aceleração de upload requer aprovação prévia mediante solicitação. Consulte Aceleração de upload para instruções de ativação e regras de faturamento.

Código de exemplo

UserData={
  "MessageCallback": {
    "MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com",
    "MNSQueueName":"vod-callback-bj",
    "CallbackType": "mns"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}
                        

EncryptConfig: defina as configurações para criptografia HLS

Este campo estabelece os parâmetros necessários para a criptografia HLS.

Campo

Tipo

Obrigatório

Descrição

CipherText

String

Sim

Chave cifrada utilizada para recuperar a chave em texto simples. Preencha com o valor de CiphertextBlob retornado na resposta da operação GenerateKMSDataKey.

DecryptKeyUri

String

Sim

URI da chave derivada da chave cifrada. Composta pelo endereço IP do serviço de descriptografia concatenado ao valor de Ciphertext.

Refere-se ao serviço de descriptografia implementado por você. Por exemplo, se o IP do seu serviço for http://demo.aliyundoc.com, configure o parâmetro assim:

http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt****

KeyServiceType

String

Sim

Tipo de serviço de chave. Valor padrão: KMS, referente ao Key Management Service da Alibaba Cloud.

SpriteSnapshotConfig: defina as configurações para captura de sprites de imagem

Campo

Tipo

Obrigatório

Descrição

CellWidth

String

Não

Largura dos snapshots originais que formam o sprite de imagem. Padrão: largura de um snapshot normal. Unidade: pixels.

CellHeight

String

Não

Altura dos snapshots originais que compõem o sprite de imagem. Padrão: altura de um snapshot normal. Unidade: pixels.

Padding

String

Não

Espaçamento interno entre os snapshots originais no sprite de imagem. Padrão: 0. Unidade: pixels.

Margin

String

Não

Margem externa dos snapshots originais no sprite de imagem. Padrão: 0. Unidade: pixels.

Color

String

Não

Cor de fundo do sprite de imagem. Padrão: Preto.

Columns

String

Não

Quantidade de colunas para organizar os snapshots originais no sprite. Intervalo válido: [1,10000]. Padrão: 10.

Lines

String

Não

Número de linhas para dispor os snapshots originais no sprite. Intervalo válido: [1,10000]. Padrão: 10.

KeepCellPic

String

Não

Indica se os snapshots originais que formam o sprite devem ser mantidos. Valores válidos:

  • keep

  • exclua

Valor padrão: keep.

Nota

Para aplicar os valores padrão a todos os campos de SpriteSnapshotConfig, forneça uma string JSON vazia.