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

Consulta as informações de um projeto de edição online.

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

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	string	Sim	O ID do projeto de edição online.	**fb2101bf24b2754cb318787dc**
RequestSource	string	Não	O ID da origem da solicitação. Valores válidos: - OpenAPI (padrão): A conversão da linha do tempo não é realizada. - WebSDK: Se você especificar este valor, a linha do tempo do projeto será automaticamente convertida para o estilo de frontend, e os materiais na linha do tempo serão associados ao projeto para permitir a pré-visualização usando SDKs web de frontend.	WebSDK

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	**63E8B7C7-4812-46AD-0FA56029AC86**
Project	object	As informações do projeto de edição online.
ProjectId	string	O ID do projeto de edição online.	**fb2101bf24b2754cb318787dc**
Title	string	O título do projeto de edição online.	Sample title
Timeline	string	A linha do tempo do projeto de edição online.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"1656bca4474999c961a6d2a2**"}]}]}
TemplateId	string	O ID do modelo.	**96e8864746a0b6f3**
ClipsParam	string	O parâmetro de material correspondente ao modelo, no formato JSON. Se TemplateId for especificado, ClipsParam também deverá ser especificado. Para obter mais informações.	See the template user guide.
Description	string	A descrição do projeto de edição online.	Example description
CoverURL	string	A URL da miniatura do projeto de edição online.	http://aaa.bbb/your-cover.jpg
CreateTime	string	A hora em que o projeto de edição online foi criado.	2020-12-20T12:00:00Z
ModifiedTime	string	A hora em que o projeto de edição online foi modificado pela última vez.	2020-12-20T13:00:00Z
Duration	integer	A duração total do projeto de edição online.	24.120000
Status	string	O status do projeto de edição online. Valores válidos: - Draft - Editing - Producing - Produced - ProduceFailed - Deleted	Editing
CreateSource	string	O método de criação do projeto de edição online. Valores válidos: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	OpenAPI
TemplateType	string	O tipo de modelo do projeto de edição online. Valores válidos: - Timeline - VETemplate	Timeline
ModifiedSource	string	O método de edição do projeto de edição online. Valores válidos: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	OpenAPI
ProjectType	string	O tipo do projeto de edição. Valor padrão: EditingProject. Valores válidos: - EditingProject: um projeto de edição comum. - LiveEditingProject: um projeto de edição de transmissão ao vivo.	EditingProject
BusinessConfig	string	A configuração de negócios do projeto. Este parâmetro pode ser ignorado para projetos de edição gerais.	{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
BusinessStatus	string	O status de negócios do projeto. Este parâmetro pode ser ignorado para projetos de edição gerais. Valores válidos: Reserving ReservationCanceled BroadCasting LoadingFailed LiveFinished.	Reserving
TimelineConvertStatus	string	O status de conversão do projeto. A conversão de uma linha do tempo no estilo de API para uma linha do tempo no estilo de frontend é um processo assíncrono e entra em vigor apenas se RequestSource:WebSDK for especificado. - Unconverted - Converting - Converted - ConvertFailed	Converted
TimelineConvertErrorMessage	string	A mensagem de erro retornada se a conversão do projeto falhar. A mensagem de erro exibe as informações detalhadas sobre a falha e é retornada apenas se o valor de TimelineConvertStatus for ConvertFailed.	The StorageLocation must be in the same division(apiRegion) as ICE service access point.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Project": {
    "ProjectId": "****fb2101bf24b2754cb318787dc****",
    "Title": "Sample title",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "See the template user guide.",
    "Description": "Example description",
    "CoverURL": "http://aaa.bbb/your-cover.jpg",
    "CreateTime": "2020-12-20T12:00:00Z",
    "ModifiedTime": "2020-12-20T13:00:00Z",
    "Duration": 24.12,
    "Status": "Editing",
    "CreateSource": "OpenAPI",
    "TemplateType": "Timeline",
    "ModifiedSource": "OpenAPI",
    "ProjectType": "EditingProject",
    "BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
    "BusinessStatus": "Reserving",
    "TimelineConvertStatus": "Converted",
    "TimelineConvertErrorMessage": "The StorageLocation must be in the same division(apiRegion) as ICE service access point."
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter \ is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.