DescribeLiveAIStudio - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Consulta os modelos de estúdio virtual em sua conta.

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

live:DescribeLiveAIStudio

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-shanghai
StudioId	string	Não	O ID do modelo a ser filtrado. Este parâmetro é opcional.	dbe61b87-db9a-448f-8757-a875edb3f944
StudioName	string	Não	O nome do modelo de estúdio virtual.	sub02
PageNumber	integer	Não	O número da página atual. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valores válidos: 1 a 50.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	O número total de modelos.	100
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas retornadas em cada página. Valor padrão: 10. Valores válidos: 1 a 50.	10
StudioConfigs	object
SubtitleConfig	array<object>	As informações sobre o modelo de estúdio virtual.
	array<object>	As informações sobre o modelo de estúdio virtual.
MediaType	string	The type of the media asset. Valid values: VOD, PIC, and LIVE. VOD: a video-on-demand file. PIC: an image. LIVE: a live stream.	VOD
MediaLayout	string	The layout information of the media asset.	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MediaResourceUrl	string	The URL of the media asset.	https://testbucket.xx.com/2.jpg
MediaResourceId	string	The ID of the VOD resource for the media asset.	d0eb493192c771efba644531858c0102
BackgroundType	string	The type of the background material. Valid values: VOD, PIC, and LIVE. VOD: a video-on-demand file. PIC: an image. LIVE: a live stream.	VOD
BackgroundResourceUrl	string	The public URL of the background material. The URL must be accessible over the Internet. Specify this parameter or `BackgroundResourceId`.	https://testbucket.xx.com/2.jpg
BackgroundResourceId	string	The ID of the background material resource.	d0eb493192c771efba644531858c0102
Description	string	The description of the virtual studio template.	user defined description
TemplateId	string	The ID of the virtual studio template.	24654384-f5ac-40ea-823b-74e85a61dd9f
TemplateName	string	The name of the virtual studio template. This parameter is the same as the `StudioName` parameter in the AddLiveAiStudio operation.	studio1
MattingLayout	string	The layout of the keyed-out portrait.	"{\"positionY\":\"0.0\",\"positionX\":\"0.0\",\"heightNormalized\":\"0.5\"}"
MattingType	string	The chroma keying type for the source stream. This is used to process the ingested stream. green: chroma keying for a portrait against a green screen background. blue: chroma keying for a portrait against a blue screen background. complex: chroma keying for a portrait against a real-world background.	complex
Height	string	The height of the preview image, in pixels. The resolution of the preview image (width × height) must be one of the following: Landscape low definition (360p): 640 × 360 Portrait low definition (360p): 360 × 640 Landscape standard definition (480p): 854 × 480 Portrait standard definition (480p): 480 × 854 Landscape high definition (720p): 1280 × 720 Portrait high definition (720p): 720 × 1280 Landscape ultra-high definition (1080p): 1920 × 1080 Portrait ultra-high definition (1080p): 1080 × 1920	1080
Width	string	The width of the preview image.	1920
RuleIds	object
ruleId	array	The rule IDs.
	string	The rule ID.	2414378f-541a-48d3-be0c-535212f9a6b4

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 100,
  "PageNumber": 1,
  "PageSize": 10,
  "StudioConfigs": {
    "SubtitleConfig": [
      {
        "MediaType": "VOD",
        "MediaLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MediaResourceUrl": "https://testbucket.xx.com/2.jpg",
        "MediaResourceId": "\t\nd0eb493192c771efba644531858c0102\n",
        "BackgroundType": "VOD",
        "BackgroundResourceUrl": "https://testbucket.xx.com/2.jpg",
        "BackgroundResourceId": "d0eb493192c771efba644531858c0102",
        "Description": "user defined description",
        "TemplateId": "24654384-f5ac-40ea-823b-74e85a61dd9f",
        "TemplateName": "studio1",
        "MattingLayout": "\"{\\\"positionY\\\":\\\"0.0\\\",\\\"positionX\\\":\\\"0.0\\\",\\\"heightNormalized\\\":\\\"0.5\\\"}\"",
        "MattingType": "complex",
        "Height": "1080",
        "Width": "1920",
        "RuleIds": {
          "ruleId": [
            "2414378f-541a-48d3-be0c-535212f9a6b4"
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
400	InvalidParameter.PurchaseTime	%s, please check and try again later.	The parameter PurchaseTime is invalid, please check and try again.
400	InvalidParameter.ExpireTime	%s, please check and try again later.	The parameter ExpireTime is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
400	InvalidChargeType.Malformed	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidChargeType.PostSupport	%s, please check and try again later.	ChargeType only supports post-paid, please check and try again.
400	InvalidCasterTemplate.Malformed	%s, please check and try again later.	The parameter CasterTemplate is invalid, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.ChargeType	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidPeriod.Malformed	%s, please check and try again later.	Invalid time interval, please check and try again.
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidClientToken.Malformed	%s, please check and try again later.	The parameter ClientToken is invalid, please check and try again.
400	IncorrectCasterStatus	%s, please check and try again later.	Guide station status error, please check and try again.
401	CasterNumberExceed	%s, please check and try again later.	The number of casters exceeds the limit. Please check and try again.
403	PermissionDenied	%s, please check and try again later.	Access denied, please check and try again.
404	InvalidParameter.NormType	%s, please check and try again later.	The parameter NormType is invalid, please check and try again.
404	InvalidConfiguration.NotFound	%s, please check and try again later.	Configuration does not exist, please check and try again.
408	DescribeLiveAIStudio.Timeout	%s, please try again later.	Call DescribeLiveAIStudio timed out, please try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.