GetTemplate - Intelligent Media Services: Central de Documentação do Alibaba Cloud

Consulta as informações sobre um modelo com base no ID do modelo. Consulta as informações sobre um modelo avançado se o modelo estiver no estado Available.

Descrição da operação

Um modelo é um encapsulamento da timeline de um trabalho de edição e produção de mídia. Você pode definir uma timeline comum como um modelo. Quando tiver os mesmos requisitos, você precisa apenas especificar os parâmetros-chave e os materiais para produzir vídeos.

Para mais informações sobre como usar um modelo regular, consulte Criar e usar um modelo regular.
Para mais informações sobre como usar um modelo avançado, consulte Criar e usar modelos avançados.

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

ice:GetTemplate

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TemplateId	string	Não	O ID do modelo.	**20b48fb04483915d4f2cd8ac**
RelatedMediaidFlag	string	Não	Especifica se as informações sobre os materiais associados devem ser retornadas. Valor padrão: 0. Valores válidos: 0 e 1. O valor 1 especifica que as informações sobre os materiais associados são retornadas. Este parâmetro é válido apenas para modelos regulares.	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	****11-DB8D-4A9A-875B-275798****
Template	object	As informações do modelo.
TemplateId	string	O ID do modelo.	**20b48fb04483915d4f2cd8ac**
Name	string	O nome do modelo.	Video watermark template
Type	string	O tipo do modelo. Valores válidos: Timeline VETemplate	Timeline
Config	string	As configurações do modelo. Para mais informações sobre as configurações de um modelo regular, consulte Objeto Config de um modelo regular. Para mais informações sobre as configurações de um modelo avançado, consulte Criar e usar modelos avançados.	See Timeline template configuration details.
PreviewMedia	string	O ativo de mídia de pré-visualização.	**20b48fb04483915d4f2cd8ac**
Status	string	O estado do modelo. Valores válidos: Available Created Uploading Processing UploadFailed ProcessFailed	Available
CreateSource	string	A origem a partir da qual o modelo foi criado. Valores válidos: AliyunConsole OpenAPI WebSDK	OpenAPI
ModifiedSource	string	A origem a partir da qual o modelo foi modificado. Valores válidos: AliyunConsole OpenAPI WebSDK	OpenAPI
PreviewMediaStatus	string	O estado do ativo de mídia de pré-visualização. Valores válidos: Init: o estado inicial, que indica que o arquivo de origem não está pronto. Preparing: O arquivo de origem está sendo preparado. Por exemplo, o arquivo está sendo carregado ou editado. PrepareFail: Falha ao preparar o arquivo de origem. Por exemplo, as informações sobre o arquivo de origem não puderam ser obtidas. Normal: O arquivo de origem está pronto.	Normal
CreationTime	string	A hora em que o modelo foi criado.	2020-12-26T04:11:10Z
ModifiedTime	string	A hora em que o modelo foi modificado pela última vez.	2020-12-26T04:11:10Z
CoverURL	string	A URL da miniatura.	http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
ClipsParam	string	Os parâmetros de clipe para enviar um trabalho de produção de vídeo. Você pode substituir mediaId e text por valores reais para enviar um trabalho. Referências: Criar e usar um modelo regular Criar e usar modelos avançados	{"Media1":"mediaId","Text1":"text"}
RelatedMediaids	string	Os IDs dos materiais associados ao modelo para uso pelo editor de modelos regulares.	{"video":["****c04f1d4a06996144cc1a**"],"audio":["**c04f1d4a06996144cc1a**"],"image":["**c04f1d4a06996144cc1a****"]}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "Name": "Video watermark template",
    "Type": "Timeline",
    "Config": "See Timeline template configuration details.",
    "PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI",
    "PreviewMediaStatus": "Normal",
    "CreationTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "ClipsParam": "{\"Media1\":\"mediaId\",\"Text1\":\"text\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

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.