SearchMedia - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Pesquisa informações de ativos de mídia, como vídeos, arquivos de áudio e imagens produzidos pelo ApsaraVideo VOD. Você pode usar esta operação com o protocolo de pesquisa de ativos de mídia para realizar pesquisas multidimensionais no ApsaraVideo VOD, incluindo a especificação de campos de retorno, correspondência exata, correspondência aproximada, consultas de múltiplos valores, consultas de intervalo e campos de ordenação.

Descrição da operação

Para campos que suportam correspondência exata e correspondência aproximada, quando outros métodos de consulta são usados, os resultados retornados seguem o método de consulta suportado pelo campo. Por exemplo, se um campo suporta apenas correspondência aproximada, os resultados obtidos por meio de consultas de múltiplos valores também serão baseados em correspondência aproximada.

A seguir são descritos os limites sobre o número de registros de dados que podem ser recuperados:

Método 1: Travessia paginada

Para resultados de pesquisa correspondentes, você pode definir os parâmetros de paginação PageNo (número da página) e PageSize (número de registros por página) para percorrer até 5.000 registros. Se os resultados da pesquisa excederem 5.000 registros, ajuste as condições de pesquisa para restringir o intervalo de resultados. Este método não consegue percorrer o conjunto de dados completo. Para percorrer mais dados, consulte o Método 2.
Método 2: Travessia completa (apenas para pesquisas de áudio e vídeo)

Este método aplica-se a pesquisas de conteúdo de vídeo e áudio e suporta a travessia de até 2 milhões de resultados de pesquisa. Se o número de resultados de pesquisa exceder 2 milhões, adicione mais condições de filtro para reduzir a contagem de resultados. Ao usar este método, além de PageNo e PageSize, você deve usar o parâmetro ScrollToken para paginação. Cada solicitação suporta a travessia de até 100 registros para frente. Usando um PageSize de 20 como exemplo, a lógica de paginação é a seguinte:
- Se PageNo for 1, você pode consultar até as próximas 5 páginas de dados.
- Se PageNo for 2, você pode consultar até as próximas 6 páginas de dados.

Defina os parâmetros de paginação adequadamente e escolha o método de travessia apropriado com base no tamanho do conjunto de resultados. Se você precisar paginar por mais de 1.000 registros, use o Método 2 para um processamento de dados mais rápido e conveniente.

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

list

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SearchType	string	Não	O tipo de ativo de mídia a ser pesquisado. Valores válidos: video (padrão): vídeo. audio: áudio. image: imagem. attached: ativo de mídia auxiliar. Nota Se este parâmetro for definido como video ou audio e você precisar percorrer todos os dados que correspondem às condições de pesquisa, deverá definir o parâmetro ScrollToken.	video.
Fields	string	Não	Os campos de ativo de mídia a serem retornados nos resultados da pesquisa. Por padrão, apenas campos básicos de ativo de mídia são retornados. Você pode especificar campos adicionais de ativo de mídia para retorno. Para mais informações, consulte Exemplos de uso.	Title,CoverURL.
Match	string	Não	As condições de filtro. Para regras de sintaxe, consulte Sintaxe do protocolo de pesquisa.	field = value.
SortBy	string	Não	O campo de ordenação e a ordem de classificação. Separe múltiplos valores com vírgulas (,). Valores válidos: CreationTime:Desc (padrão): ordena por hora de criação em ordem decrescente. CreationTime:Asc: ordena por hora de criação em ordem crescente. Nota Para exemplos de campos de ordenação, consulte Campos de ordenação. Ao recuperar os primeiros 5.000 registros dos resultados de pesquisa, até três campos de ordenação são suportados. Ao recuperar todos os dados que correspondem às condições de pesquisa, apenas um campo de ordenação é suportado.	CreationTime:Desc.
PageNo	integer	Não	O número da página. Valor padrão: 1. Nota Se este parâmetro exceder 200, defina também o parâmetro ScrollToken.	1
PageSize	integer	Não	O número de registros por página. Valor padrão: 10. Valor máximo: 100.	10
ScrollToken	string	Não	O token de paginação. O valor é uma string de 32 caracteres. Você não precisa definir este parâmetro na primeira solicitação de pesquisa. Quando a solicitação de pesquisa corresponde a dados, o servidor retorna este valor de parâmetro, que registra a posição atual dos dados de pesquisa. Registre o valor retornado e defina este parâmetro na próxima solicitação de pesquisa com base nos seguintes requisitos ou recomendações: Se SearchType estiver definido como video ou audio e você precisar percorrer todos os dados que correspondem às condições de pesquisa, este parâmetro é obrigatório. Se PageNo exceder 200, defina este parâmetro para otimizar o desempenho da pesquisa.	24e0fba7188fae707e146esa54****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	3E0CEF83-FB09-4E34-BA1451814B03****
Total	integer	O número total de ativos de mídia que correspondem às condições de pesquisa.	10
ScrollToken	string	O token de paginação.	24e0fba7188fae707e146esa54****
MediaList	array<object>	A lista de informações de ativos de mídia.
	array<object>	Os detalhes do ativo de mídia.
CreationTime	string	A hora em que o ativo de mídia foi criado. A hora está no formato aaaa-MM-ddTHH:mm:ssZ (UTC).	2018-07-19T03:45:25Z
MediaType	string	O tipo de mídia. Valores válidos: video: vídeo. audio: áudio. image: imagem. attached: ativo de mídia auxiliar.	video.
MediaId	string	O ID da mídia.	a82a2cd7d4e147bbed6c1ee372****
Video	object	Informações do vídeo.
Status	string	O status. Valores válidos: Uploading: O vídeo está sendo carregado. UploadFail: O vídeo falhou ao ser carregado. UploadSucc: O vídeo foi carregado. Transcoding: O vídeo está sendo transcodificado. TranscodeFail: O vídeo falhou ao ser transcodificado. Blocked: O vídeo está bloqueado. Normal: O vídeo está em estado normal.	UploadSucc
CreationTime	string	A hora em que as informações do vídeo foram criadas. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:45:25Z
StorageLocation	string	A região de armazenamento.	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CateId	integer	O ID da categoria.	10000123
Tags	string	As tags do vídeo.	tag1
ModificationTime	string	A hora em que as informações do vídeo foram atualizadas pela última vez. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:48:25Z
MediaSource	string	A origem. Valores válidos: general: Upload VOD. short_video: SDK de vídeo curto. editing: Edição e produção de vídeo. live: Gravação de transmissão ao vivo.	general
Description	string	A descrição do vídeo.	Alibaba Cloud VOD video description
AppId	string	O ID da aplicação.	app-****
CoverURL	string	A URL da miniatura.	https://example.aliyundoc.com/image01.png
VideoId	string	O ID do vídeo.	a82a2asdasqadaf3faa0ed6c1ee372****
DownloadSwitch	string	O switch de download. O download offline é permitido apenas quando o switch está ativado. Valores válidos: on: O estado inicial. O download offline é permitido. off: O download offline está desativado.	on
CateName	string	O nome da categoria.	video1
TranscodeMode	string	O modo de transcodificação. Valores válidos: FastTranscode (Transcodificação normal): O modo padrão. A transcodificação começa imediatamente após a conclusão do upload. A reprodução fica disponível após a conclusão da transcodificação. NoTranscode (Distribuir sem transcodificação): Nenhuma transcodificação é realizada após a conclusão do upload. A reprodução fica disponível imediatamente. AsyncTranscode (Distribuir após upload e transcodificar de forma assíncrona): A reprodução fica disponível imediatamente após a conclusão do upload. A transcodificação é realizada de forma assíncrona.	FastTranscode
PreprocessStatus	string	O status de pré-processamento. Valores válidos: UnPreprocess: Não pré-processado. Preprocessing: Pré-processando. PreprocessSucceed: Pré-processamento bem-sucedido. PreprocessFailed: Pré-processamento falhou.	Preprocessing
RestoreExpiration	string	O tempo de expiração do ativo de mídia restaurado.	2023-03-30T10:14:14Z
RestoreStatus	string	O estado de restauração do ativo de mídia. Valores válidos: Processing: Restaurando. Success: Restaurado. Failed: A restauração falhou.	Success
StorageClass	string	A classe de armazenamento do ativo de mídia. Valores válidos: Standard: Standard. IA: Infrequent Access (IA). Archive: Archive. ColdArchive: Cold Archive. SourceIA: Source IA. SourceArchive: Source Archive. SourceColdArchive: Source Cold Archive. Changing: A classe de armazenamento está sendo alterada. SourceChanging: A classe de armazenamento do arquivo de origem está sendo alterada.	Standard
Size	integer	O tamanho do vídeo.	123
Duration	number	A duração do vídeo. Unidade: segundos.	123
Title	string	O título do vídeo.	Alibaba Cloud VOD Video Title
SpriteSnapshots	array	A lista de sprites.
	string	A lista de sprites.	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	A lista de snapshots capturados automaticamente.
	string	A lista de snapshots capturados automaticamente.	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	O ID personalizado. Pode conter letras minúsculas, letras maiúsculas, dígitos, hifens (-) e underscores (_). O ID deve ter de 6 a 64 caracteres e ser exclusivo para cada usuário.	123-123
Audio	object	Informações do áudio.
Status	string	O status. Valores válidos: Uploading: O áudio está sendo carregado. Normal: O áudio está em estado normal. UploadFail: O áudio falhou ao ser carregado. Deleted: O áudio foi excluído.	Normal
CreationTime	string	A hora em que o áudio foi criado. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:45:25Z
StorageLocation	string	A região de armazenamento.	outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com
CateId	integer	O ID da categoria.	10000123
Tags	string	As tags.	tag1,tag2
ModificationTime	string	A hora em que o áudio foi atualizado pela última vez. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:48:25Z
MediaSource	string	A origem. Valores válidos: general (Upload VOD): O arquivo é carregado usando um método normal. short_video (SDK de vídeo curto): O arquivo é carregado no VOD usando um SDK de vídeo curto. Para mais informações, consulte SDK de vídeo curto. editing (Edição online): O arquivo é carregado no VOD após ser sintetizado usando edição online. Para mais informações, consulte Síntese de vídeo. live (Gravação de transmissão ao vivo): O arquivo é carregado no VOD após ser gravado de uma transmissão ao vivo.	general
Description	string	A descrição.	Alibaba Cloud VOD Audio Description
AppId	string	O ID da aplicação.	app-****
CoverURL	string	A URL da miniatura.	http://example.com/image04.jpg
AudioId	string	O ID do áudio.	a82a2cd7d4e147bbed6c1ee372****
DownloadSwitch	string	O switch de download. O download offline é permitido apenas quando o switch está ativado. Valores válidos: on: O estado inicial. O download offline é permitido. off: O download offline está desativado.	on
CateName	string	O nome da categoria.	cate1
TranscodeMode	string	O modo de transcodificação. Valores válidos: FastTranscode (Transcodificação normal, padrão): A transcodificação começa imediatamente após a conclusão do upload. A reprodução fica disponível após a conclusão da transcodificação. NoTranscode (Distribuir sem transcodificação): Nenhuma transcodificação é realizada após a conclusão do upload. A reprodução fica disponível imediatamente. AsyncTranscode (Distribuir após upload e transcodificar de forma assíncrona): A reprodução fica disponível imediatamente após a conclusão do upload. A transcodificação é realizada de forma assíncrona.	FastTranscode
PreprocessStatus	string	O status de pré-processamento. Apenas arquivos de áudio pré-processados podem ser usados para direção de transmissão ao vivo. Valores válidos: UnPreprocess: Não pré-processado. Preprocessing: Pré-processando. PreprocessSucceed: Pré-processamento bem-sucedido. PreprocessFailed: Pré-processamento falhou.	UnPreprocess
RestoreExpiration	string	O tempo de expiração do ativo de mídia restaurado.	2023-03-30T10:14:14Z
RestoreStatus	string	O estado de restauração do ativo de mídia. Valores válidos: Processing: Restaurando. Success: Restaurado. Failed: A restauração falhou.	Success
StorageClass	string	A classe de armazenamento do ativo de mídia. Valores válidos: Standard: Standard. IA: IA. Archive: Archive. ColdArchive: Cold Archive. SourceIA: Source IA. SourceArchive: Source Archive. SourceColdArchive: Source Cold Archive. Changing: A classe de armazenamento está sendo alterada.	Standard
Size	integer	O tamanho.	123
Duration	number	A duração.	123
Title	string	O título.	Alibaba Cloud VOD Audio Title
SpriteSnapshots	array	A lista de sprites.
	string	A lista de sprites.	{“http://example.aliyundoc.com/image02.jpg”}
Snapshots	array	A lista de snapshots capturados automaticamente.
	string	A lista de snapshots capturados automaticamente.	{“http://example.aliyundoc.com/image03.jpg”}
ReferenceId	string	O ID personalizado. Pode conter letras minúsculas, letras maiúsculas, dígitos, hifens (-) e underscores (_). O ID deve ter de 6 a 64 caracteres e ser exclusivo para cada usuário.	123-123
Image	object	Informações da imagem.
StorageLocation	string	A região de armazenamento.	outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
CreationTime	string	A hora em que a imagem foi criada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:45:25Z
Status	string	O status da imagem. Uploading: O estado inicial. A imagem está sendo carregada. Normal: A imagem foi carregada. UploadFail: A imagem falhou ao ser carregada.	Uploading
CateId	integer	O ID da categoria.	1000123
Tags	string	As tags.	tag1
ModificationTime	string	A hora em que a imagem foi atualizada pela última vez. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:48:25Z
CateName	string	O nome da categoria.	cate1
Description	string	A descrição.	Alibaba Cloud VOD Image Description
AppId	string	O ID da aplicação.	app-****
URL	string	A URL da imagem.	https://example.com/****.png
Title	string	O título.	Alibaba Cloud VOD Image Title
ImageId	string	O ID da imagem.	11130843741se99wqmoes****
AttachedMedia	object	Informações do ativo de mídia auxiliar.
CreationTime	string	A hora em que o ativo foi criado. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:45:25Z
Status	string	O status. Valores válidos: Uploading: O estado inicial. O ativo de mídia auxiliar está sendo carregado. Normal: O ativo de mídia auxiliar foi carregado. UploadFail: O ativo de mídia auxiliar falhou ao ser carregado.	Normal
StorageLocation	string	A região de armazenamento.	outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com
Tags	string	As tags.	tag1
ModificationTime	string	A hora em que o ativo foi atualizado pela última vez. A hora está no formato yyyy-MM-ddTHH:mm:ssZ em UTC.	2018-07-19T03:48:25Z
MediaId	string	O ID do ativo de mídia auxiliar.	a82a2cd7d4e147ba0ed6c1ee372****
BusinessType	string	O tipo de negócio. Valores válidos: watermark: marca d'água. subtitle: legenda. material: material.	watermark
Description	string	A descrição.	Alibaba Cloud VOD-assisted media asset description
AppId	string	O ID da aplicação.	app-****
URL	string	A URL do ativo de mídia auxiliar.	https://example.com/****.png
Title	string	O título.	Alibaba Cloud VOD-assisted media asset Title
Categories	array<object>	A lista de IDs de categoria.
	object	Os detalhes da categoria.
ParentId	integer	O ID do nó pai.	-1
CateName	string	O nome da categoria.	cate1
CateId	integer	O ID da categoria.	10027394
Level	integer	O nível da categoria.	1
AiData		Os detalhes de IA.
AiRoughData		Os dados de resumo de IA.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "3E0CEF83-FB09-4E34-BA1451814B03****",
  "Total": 10,
  "ScrollToken": "24e0fba7188fae707e146esa54****",
  "MediaList": [
    {
      "CreationTime": "2018-07-19T03:45:25Z",
      "MediaType": "video",
      "MediaId": "a82a2cd7d4e147bbed6c1ee372****",
      "Video": {
        "Status": "UploadSucc",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-****",
        "CoverURL": "https://example.aliyundoc.com/image01.png",
        "VideoId": "a82a2asdasqadaf3faa0ed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "video1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "Preprocessing",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Video Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Audio": {
        "Status": "Normal",
        "CreationTime": "2018-07-19T03:45:25Z",
        "StorageLocation": "outin-aaa*****aa.oss-cn-shanghai.aliyuncs.com",
        "CateId": 10000123,
        "Tags": "tag1,tag2",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaSource": "general",
        "Description": "Alibaba Cloud VOD Audio Description",
        "AppId": "app-****",
        "CoverURL": "http://example.com/image04.jpg",
        "AudioId": "a82a2cd7d4e147bbed6c1ee372****",
        "DownloadSwitch": "on",
        "CateName": "cate1",
        "TranscodeMode": "FastTranscode",
        "PreprocessStatus": "UnPreprocess",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "RestoreStatus": "Success",
        "StorageClass": "Standard",
        "Size": 123,
        "Duration": 123,
        "Title": "Alibaba Cloud VOD Audio Title",
        "SpriteSnapshots": [
          "{“http://example.aliyundoc.com/image02.jpg”}"
        ],
        "Snapshots": [
          "{“http://example.aliyundoc.com/image03.jpg”}"
        ],
        "ReferenceId": "123-123"
      },
      "Image": {
        "StorageLocation": "outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com",
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Uploading",
        "CateId": 1000123,
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "CateName": "cate1",
        "Description": "Alibaba Cloud VOD Image Description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD Image Title",
        "ImageId": "11130843741se99wqmoes****"
      },
      "AttachedMedia": {
        "CreationTime": "2018-07-19T03:45:25Z",
        "Status": "Normal",
        "StorageLocation": "outin-bfefbb90a47c11*****7426.oss-cn-shanghai.aliyuncs.com",
        "Tags": "tag1",
        "ModificationTime": "2018-07-19T03:48:25Z",
        "MediaId": "a82a2cd7d4e147ba0ed6c1ee372****",
        "BusinessType": "watermark",
        "Description": "Alibaba Cloud VOD-assisted media asset description",
        "AppId": "app-****",
        "URL": "https://example.com/****.png",
        "Title": "Alibaba Cloud VOD-assisted media asset Title",
        "Categories": [
          {
            "ParentId": -1,
            "CateName": "cate1",
            "CateId": 10027394,
            "Level": 1
          }
        ]
      }
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.