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

Consulta os detalhes de um grupo interativo ao vivo.

Descrição da operação

Antes de chamar esta operação, você deve ter chamado CreateLiveMessageGroup para criar um grupo de mensagens interativas.

Limite de QPS

O limite de QPS por usuário único para esta operação é de 50 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação 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:DescribeLiveMessageGroup

get

*Rtc.

acs:live::{#accountId}:rtc/{#AppId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo.	demo
GroupId	string	Sim	O ID do grupo.	grouptest
DataCenter	string	Não	O data center. Este valor deve ser igual ao data center especificado em CreateLiveMessageApp. Valores suportados atualmente: cn-shanghai (Xangai) e ap-southeast-1 (Singapura).	cn-shanghai

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	1815A27D-BAE2-10E6-89FD-D477951C****
GroupId	string	O ID do grupo.	grouptest
CreatorId	string	O ID do criador.	uid1
AdminList	array	A lista de administradores.
	string	O administrador.	["uid1","uid2"]
Createtime	integer	A hora de criação. Este valor é um timestamp UNIX em segundos.	1698305471
GroupName	string	O nome do grupo.	mytestgroup
GroupInfo	string	As informações estendidas do grupo.	testgroupinfo
Delete	boolean	Indica se o grupo foi excluído.	false
TotalTimes	integer	O número total de sessões. Este parâmetro é retornado apenas quando o grupo existe.	50
OnlineUserCounts	integer	O número de usuários online no grupo. Este parâmetro é retornado apenas quando o grupo existe.	2
MsgAmount	object	As estatísticas de contagem de mensagens por categoria. Este parâmetro é retornado apenas quando o grupo existe.
	integer	O número de mensagens.	{1 : 20, 2 : 30}
Deletatime	integer	A hora da exclusão. Este parâmetro é retornado apenas quando o grupo foi excluído. Este valor é um timestamp UNIX em segundos.	1698299827
Deletor	string	O usuário que excluiu o grupo. Este parâmetro é retornado apenas quando o grupo foi excluído.	uid1
SuperLargeGroup	boolean	Indica se o grupo é um super large group. Valores válidos: True: O grupo é um super large group. False: O grupo não é um super large group.	False

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1815A27D-BAE2-10E6-89FD-D477951C****",
  "GroupId": "grouptest",
  "CreatorId": "uid1",
  "AdminList": [
    "[\"uid1\",\"uid2\"]"
  ],
  "Createtime": 1698305471,
  "GroupName": "mytestgroup",
  "GroupInfo": "testgroupinfo",
  "Delete": false,
  "TotalTimes": 50,
  "OnlineUserCounts": 2,
  "MsgAmount": {
    "key": 0
  },
  "Deletatime": 1698299827,
  "Deletor": "uid1",
  "SuperLargeGroup": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InputInvalid	%s.	Os parâmetros de entrada são inválidos.
500	ServerError	%s.	Ocorreu um erro desconhecido. Tente novamente mais tarde ou abra um ticket.
403	NoAuth	%s.	Você não tem as permissões necessárias.
404	ResourceNotExist	%s.	O recurso solicitado não existe. Verifique a solicitação 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.