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

Consulta a lista de estúdios 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 estúdios de produção. Um estúdio de produção pode estar no estado ocioso ou de transmissão.

null

A conta que chama esta operação deve ter o ApsaraVideo Live ativado.

Limite de QPS

O limite de QPS para um único usuário nesta operação é de 15 chamadas por segundo. Se esse limite for excedido, as chamadas de API serão limitadas, 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:DescribeCasters

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	Não	O ID do estúdio de produção. Se você criou o estúdio de produção chamando a operação CreateCaster, verifique o 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. null 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. Se este parâmetro for deixado vazio, os dados mesclados de todos os estúdios de produção serão retornados por padrão.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	Não	O nome do estúdio de produção.	liveCaster****
StartTime	string	Não	A hora de início. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2016-06-29T09:00:00Z
EndTime	string	Não	A hora de término. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2016-06-29T11:00:00Z
PageNum	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 100.	100
Status	integer	Não	O status. Valores válidos: 0: ocioso. 1: transmissão.	0
ChargeType	integer	Não	O método de cobrança. Valores válidos: 0: PrePaid (assinatura). 1: PostPaid (pós-pago).	0
OrderByModifyAsc	string	Não	Especifica se os estúdios de produção devem ser classificados em ordem crescente pelo horário de modificação. Valores válidos: true (ordem crescente por horário de modificação) \| false (ordem decrescente por horário de modificação, que é o valor padrão). null Se este parâmetro não for especificado, o valor padrão é "false".	false
NormType	string	Não	O tipo de especificação do estúdio de produção. Valores válidos: 1: modo geral. 3: modo de lista de reprodução leve. 4: modo de estúdio virtual. 6: modo de lista de reprodução (estúdio de produção no novo modo de lista de reprodução).	1
ResourceGroupId	string	Não	O ID do grupo de recursos. Para obter mais informações sobre grupos de recursos, consulte O que é um grupo de recursos.	rg-aekzw******
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag.	TestKey
Value	string	Não	O valor da tag.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado da consulta da lista de estúdios de produção.
CasterList	object
Caster	array<object>	A lista de estúdios de produção.
	array<object>	As informações do estúdio de produção.
CasterId	string	The production studio ID. This ID can be used as a request parameter for querying production studio stream URLs, starting a production studio, adding video resources to a production studio, adding layouts to a production studio, querying the layout list of a production studio, adding components to a production studio, and adding a program list to a production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	The name of the production studio.	liveCaster****
CasterTemplate	string	The resolution configuration of the production studio. This parameter is required when the billing method is subscription. lp_ld: low definition. lp_sd: standard definition. lp_hd: high definition. lp_ud: ultra-high definition. lp_ld_v: portrait low definition. lp_sd_v: portrait standard definition. lp_hd_v: portrait high definition. lp_ud_v: portrait ultra-high definition.	lp_ld
ChannelEnable	integer	Indicates whether Channel is enabled. 0: disabled. 1: enabled.	1
ChargeType	string	The billing method. PrePaid: subscription. PostPaid: pay-as-you-go.	PrePaid
CreateTime	string	The creation time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-08-30T12:02:57Z
Duration	string	The duration. Format: hh:mm:ss (hours:minutes:seconds).	1:02:33
ExpireTime	string	The expiration time of the production studio. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-08-30T12:02:57Z
LastModified	string	The time when the production studio was last modified. For example, the time when the production studio was recently started, stopped, or had its configuration modified. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-12-01T05:08:45Z
NormType	integer	The specification type of the production studio. Valid values: 0: playlist mode. 1: general mode.	1
PurchaseTime	string	The time when the production studio was purchased. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-08-30T12:02:57Z
StartTime	string	The time when the production studio was started. This parameter is returned only when the production studio is in the streaming state. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-08-30T18:02:57Z
Status	integer	The status. Valid values: 0: idle. 1: streaming.	1
ClientTokenId	string	The request token generated by the user to ensure the idempotence of the request. The value of this parameter is custom but must be unique across different requests. The maximum length is 64 ASCII characters.	53200b81-b761-4c10-842a-a0726d97****
Tags	object
tag	array<object>	The list of tags.
	object	The tag.
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue
ResourceGroupId	string	The resource group ID. For more information about resource groups, see What is a resource group.	rg-acfmz******
RequestId	string	O ID da solicitação.	5c6a2a0df228-4a64- af62-20e91b******
Total	integer	O número total de estúdios de produção.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "CasterList": {
    "Caster": [
      {
        "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
        "CasterName": "liveCaster****",
        "CasterTemplate": "lp_ld",
        "ChannelEnable": 1,
        "ChargeType": "PrePaid",
        "CreateTime": "2017-08-30T12:02:57Z",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30T12:02:57Z",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30T12:02:57Z",
        "StartTime": "2017-08-30T18:02:57Z",
        "Status": 1,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmz******"
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b******",
  "Total": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.Status	%s, please check and try again.	Status is invalid, please check and try again.
400	InvalidParameter.StartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
400	InvalidParameter.EndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
400	LiveServiceNotFound	%s, please check and try again later.	The live service is not enabled. Please check and try again.
400	InvalidParameter.PageSize	%s, please check and try again later.	The parameter PageSize is invalid, please check and try again.
400	InvalidParameter.PageNum	%s, please check and try again later.	The parameter PageNum is invalid, please check and try again.
403	PermissionDenied	%s, please check and try again later.	Access denied, 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.