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

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

Descrição da operação

Você pode chamar esta operação para consultar a lista de programas de um estúdio de produção. Esta operação oferece suporte a nós de fonte de vídeo e de componente.

Limites de QPS

O limite de consultas por segundo (QPS) para um único usuário é de 4 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas. Isso pode afetar seus negócios. Planeje suas chamadas de acordo.

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

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 um estúdio de produção chamando a operação CreateCaster, use o valor CasterId retornado na resposta. Se você criar um estúdio de produção no console LIVE, encontre o ID na página Cloud Production Studio. Para acessar esta página, escolha LIVE > Production Studio > Cloud Production Studio. Nota O nome do estúdio de produção na lista da página Cloud Production Studio é o seu ID.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	Não	O ID do programa.	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeType	string	Não	O tipo do nó. Valores válidos: Resource: fonte de vídeo. Component: componente.	Resource
StartTime	string	Não	A hora de início. A hora deve estar no formato yyyy-MM-ddTHH:mm:ssZ e em UTC.	2016-06-29T09:00:00Z
EndTime	string	Não	A hora de término. A hora deve estar no formato yyyy-MM-ddTHH:mm:ssZ e em UTC.	2016-06-29T10:00:00Z
PageNum	integer	Não	O número da página.	5
PageSize	integer	Não	O número de programas em cada página.	10
Status	integer	Não	O status do programa. Valores válidos: 0: não iniciado 1: em reprodução 2: concluído	0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CasterId	string	O ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
Episodes	object
Episode	array<object>	Os nós.
	array<object>	Um nó.
ComponentIds	object
ComponentId	array	The component IDs.
	string	A component ID.	["1872639A-F203-4EC5-8E43-CB929282****" ]
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T10:02:00Z
EpisodeId	string	The ID of the program.	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeName	string	The name of the program.	program_name_1
EpisodeType	string	The type of the node. Valid values: Resource: video source. Component: component.	Resource
ResourceId	string	The ID of the video source.	1872639A-F203-4EC5-8E43-CB92E837****
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T09:00:00Z
Status	integer	The status of the program.	0
SwitchType	string	The switch policy. Valid values: TimeFirst: time-priority. Live programs can use only this policy. ContentFirst: content-priority.	TimeFirst
ProgramEffect	integer	Indica se a lista de programas está ativada. 0: desativada 1: ativada	1
ProgramName	string	O nome da lista de programas.	programs_name
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	O número total de entradas retornadas.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "Episodes": {
    "Episode": [
      {
        "ComponentIds": {
          "ComponentId": [
            "[\"1872639A-F203-4EC5-8E43-CB929282****\" ]"
          ]
        },
        "EndTime": "2016-06-29T10:02:00Z",
        "EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
        "EpisodeName": "program_name_1",
        "EpisodeType": "Resource",
        "ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
        "StartTime": "2016-06-29T09:00:00Z",
        "Status": 0,
        "SwitchType": "TimeFirst"
      }
    ]
  },
  "ProgramEffect": 1,
  "ProgramName": "programs_name",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Total": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidPageSize.Malformed	%s, please check and try again later.	The parameter PageSize is invalid, please check and try again.
400	InvalidPageNum.Malformed	%s, please check and try again later.	The parameter PageNum is invalid, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
500	InvalidParameter.Status	%s, please check and try again later.	Parameter Status is invalid, please check and try again.
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.