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

Consulta a configuração de um estúdio de produção.

Descrição da operação

Chame a operação CreateCaster para criar um estúdio de produção. Em seguida, chame esta operação para consultar sua configuração.

Limite de QPS

Esta operação possui um limite de consultas por segundo (QPS) de 15 chamadas por usuário. Se você exceder o limite, suas chamadas de API serão limitadas, o que pode afetar seus negócios. Planeje suas chamadas adequadamente.

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

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ê criar o estúdio de produção chamando a operação CreateCaster, use o valor de CasterId retornado na resposta. Se você criar o estúdio de produção no console, acesse a página Console LIVE > Estúdio de Produção > Estúdio de Produção em Nuvem para visualizar o ID. Nota O nome do estúdio de produção na lista da página Estúdio de Produção em Nuvem é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A configuração do estúdio de produção.
AutoSwitchUrgentConfig	string	A configuração para a alternância automática para o vídeo de reserva. `eofThres`: A duração em segundos após a qual o sistema alterna automaticamente para o vídeo de reserva se o stream for interrompido.	{"eofThres":3}
AutoSwitchUrgentOn	string	Indica se a alternância automática para o vídeo de reserva está ativada. true: Ativada. false: Desativada.	true
CallbackUrl	string	O endereço de webhook.	http://learn.aliyundoc.com/callBackLive
CasterId	string	O ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	O nome do estúdio de produção.	coco-caster10
ChannelEnable	integer	Indica se o canal está ativado. Valores válidos: 0: Desativado. 1: Ativado.	1
Delay	number	O atraso do stream. Unidade: segundos. 0: O atraso está desativado. Um valor maior que 0: O atraso está ativado.	0
DomainName	string	O domínio de streaming.	example.com
ProgramEffect	integer	O sinalizador de carrossel. Valores válidos: 0: Não efetivo. 1: Efetivo.	0
ProgramName	string	O nome do carrossel.	program_name
RecordConfig	object	Se este parâmetro estiver vazio, o recurso de gravação está desativado.
OnDemand	integer	Gravação sob demanda. Valores válidos: 0: Desativada. 1: Callback HTTP. 2: Gravação sob demanda com base nos parâmetros de ingestão de stream. 7: A gravação está desativada por padrão.	0
OssBucket	string	O local de armazenamento.	liveBucket****
OssEndpoint	string	O endpoint OSS onde o local de armazenamento reside.	oss-cn-shanghai.aliyundoc.com
RecordFormat	object
RecordFormat	array<object>	The recording format configuration.
	object	The recording length information.
CycleDuration	integer	The recording length.	3600
Format	string	The recording format.	M3U8
OssObjectPrefix	string	The name of the recording file.	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	The name of the segment.	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	O ID da solicitação.	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	A URL de saída bypass personalizada do estúdio de produção.	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	A lista de URLs de saída bypass personalizadas do estúdio de produção.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	A configuração de armazenamento.
	array<object>	A configuração de armazenamento.
HostResourceId	string	The resource ID of the production studio.	28768383240243****
Mode	integer	The caching mode for static pages. Valid values: 0: Standard mode. 1: Strong Mode. 2: No caching.	0
ResourceIds	object
ResourceId	array	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.
	string	The list of IDs of the cloud resources whose resource group you want to change. You can specify from 1 to 50 resource IDs.	1
TranscodeConfig	object	A configuração de transcodificação.
CasterTemplate	string	O modelo de transcodificação para o estúdio de produção. Valores válidos: lp_ld: Baixa definição. lp_sd: Definição padrão. lp_hd: Alta definição. lp_ud: Ultra-alta definição. lp_ld_v: Baixa definição vertical. lp_sd_v: Definição padrão vertical. lp_hd_v: Alta definição vertical. lp_ud_v: Ultra-alta definição vertical.	lp_hd
LiveTemplateIds	object
LocationId	array	The live stream transcoding configuration.
	string	The live stream transcoding configuration. Valid values: lsd: Standard definition. lld: Low definition. lud: Ultra-high definition. lhd: High-definition adaptive transcoding template. daobo-lsd: Standard definition. daobo-lld: Low definition. daobo-lud: Ultra-high definition. daobo-lhd: High definition.	lld
CustomParams	object	Configuração personalizada.
video	object	Video parameters
fps	integer	Video frame rate	300
bitrate	integer	Video bitrate	300
width	integer	The video width in pixels (px).	1080
height	integer	The video height in pixels (px).	720
UrgentImageId	string	O ID do ativo de imagem de reserva na biblioteca de ativos de mídia.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	A URL do ativo de imagem de reserva.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	A URL do live stream de reserva.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	O ID do ativo de vídeo de reserva na biblioteca de ativos de mídia.	98646538-bcf9-4aef-bd4a-e6bb76588****

Exemplos

Resposta de sucesso

JSON formato

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    },
    "CustomParams": {
      "video": {
        "fps": 300,
        "bitrate": 300,
        "width": 1080,
        "height": 720
      }
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****"
}

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.	The parameter CasterId is invalid, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.