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

Consulta a lista de cenas em um estúdio de produção.

Descrição da operação

Crie um estúdio de produção chamando a operação CreateCaster e, em seguida, chame esta operação para consultar a lista de cenas no estúdio de produção.

Limite de QPS

O limite de QPS por usuário para esta operação é de 15 chamadas por segundo. Se o limite for excedido, a chamada da API será limitada, o que pode afetar seus negócios. Chame esta operação conforme necessário.

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

get

*Caster.

acs:live:*:{#accountId}:caster/{#CasterId}

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
CasterId	string	Sim	O ID do estúdio de produção. Se você criou o estúdio de produção chamando a operação CreateCaster, verifique o valor do parâmetro CasterId retornado pela operação CreateCaster. Se você criou o estúdio de produção no console do ApsaraVideo Live, acesse Console do ApsaraVideo Live > Estúdios de Produção > Estúdio de Produção em Nuvem para visualizar o ID. O estúdio de produção especificado por CasterId deve ter um DomainName configurado por meio de SetCasterConfig. Caso contrário, o erro InvalidDomainName.NotFound será retornado. Nota O nome do estúdio de produção na lista de estúdios de produção na página Estúdio de Produção em Nuvem é o ID do estúdio de produção.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	Não	O ID da cena.	b5f8c837-ceeb-424f-b30b-68e94e86****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	CF60DB6A-7FD6-426E-9288-122CC1*****
SceneList	object
Scene	array<object>	A lista de informações das cenas.
	array<object>	A lista de informações das cenas.
ComponentIds	object
componentId	array	A lista de IDs de componentes.
	string	A lista de IDs de componentes.	["1506396160-0-0-7de771a77102680861853af862d5****"]
LayoutId	string	O ID do layout.	37cb2f8b-f152-4338-b928-6704f71d****
OutputType	string	Indica se a cena é a que está sendo transmitida. Valores válidos: 0: A cena é usada para pré-visualização. 1: A cena está sendo transmitida.	0
SceneId	string	O ID da cena. Você pode usar este ID como parâmetro de solicitação para atualizar a configuração de áudio de uma cena, consultar a configuração de áudio de uma cena, iniciar uma cena ou parar uma cena.	b5f8c837-ceeb-424f-b30b-68e94e86****
SceneName	string	O nome da cena.	scene1
Status	integer	O status da cena. Valores válidos: 0: desativada. 1: ativada.	0
StreamInfos	object
StreamInfo	array<object>	A lista de URLs de reprodução.
	object	A lista de URLs de reprodução.
OutputStreamUrl	string	A URL de reprodução.	http://live/caster/example.net
TranscodeConfig	string	A configuração de transcodificação. Valores válidos: sd: definição padrão. lld: baixa definição. lud: ultra-alta definição. lhd: alta definição.	lld
VideoFormat	string	O formato. Valores válidos: flv mp4 m3u8	flv
StreamUrl	string	A URL do stream de saída.	rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
Total	integer	O número total de registros.	2

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1*****",
  "SceneList": {
    "Scene": [
      {
        "ComponentIds": {
          "componentId": [
            "[\"1506396160-0-0-7de771a77102680861853af862d5****\"]"
          ]
        },
        "LayoutId": "37cb2f8b-f152-4338-b928-6704f71d****",
        "OutputType": "0",
        "SceneId": "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "SceneName": "scene1",
        "Status": 0,
        "StreamInfos": {
          "StreamInfo": [
            {
              "OutputStreamUrl": "http://live/caster/example.net",
              "TranscodeConfig": "lld",
              "VideoFormat": "flv"
            }
          ]
        },
        "StreamUrl": "rtmp://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****"
      }
    ]
  },
  "Total": 2
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidCasterId.Malformed	%s, please check and try again later.	O parâmetro CasterId é inválido. Verifique o parâmetro e tente novamente.
400	InvalidSceneId.Malformed	%s, please check and try again later.	O parâmetro SceneId é inválido. Verifique o parâmetro e tente novamente.
401	IllegalOperation	%s, please check and try again later.	A operação é inválida. Verifique a solicitação e tente novamente.
500	InternalError	%s, please try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
404	InvalidCaster.NotFound	%s, please check and try again later.	O estúdio de produção não existe. Verifique a configuração e tente novamente.
404	InvalidDomainName.NotFound	%s, please check and try again later.	O nome de domínio não existe. Verifique o nome de domínio e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.