ListTransitRouterMulticastGroups - Cloud Enterprise Network: Central de Documentação do Alibaba Cloud

Consulta os detalhes de membros multicast e fontes multicast em um domínio multicast.

Descrição da operação

Você pode chamar a operação ListTransitRouterMulticastGroups para consultar informações sobre membros multicast e fontes multicast (doravante referidos como recursos multicast) em um domínio multicast.

Se você especificar o parâmetro GroupIpAddress, poderá consultar recursos multicast em um grupo multicast especificado dentro do domínio multicast.
Se você especificar o parâmetro VSwitchIds, poderá consultar recursos multicast sob um vSwitch especificado dentro do domínio multicast.
Se você especificar o parâmetro PeerTransitRouterMulticastDomains, poderá consultar recursos multicast entre regiões dentro do domínio multicast.
Se você especificar o parâmetro ResourceType, poderá consultar recursos multicast de um tipo de recurso especificado dentro do domínio multicast.
Se você especificar o parâmetro ResourceId, poderá consultar recursos multicast associados a um recurso especificado.
Se você especificar apenas o parâmetro TransitRouterMulticastDomainId, poderá consultar todos os recursos multicast dentro do domínio multicast.

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

cen:ListTransitRouterMulticastGroups

get

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token de cliente pode conter apenas caracteres ASCII.	123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainId	string	Não	O ID do domínio multicast. Você deve especificar pelo menos um entre TransitRouterMulticastDomainId e TransitRouterAttachmentId.	tr-mcast-domain-5mjb5gjb6dgu98****
GroupIpAddress	string	Não	O endereço IP do grupo multicast. Cada grupo multicast é identificado por um endereço IP multicast.	239.XX.XX.2
TransitRouterAttachmentId	string	Não	O ID da conexão da instância de rede. Você deve especificar pelo menos um entre TransitRouterMulticastDomainId e TransitRouterAttachmentId.	tr-attach-g3kz2k3u76amsk****
VSwitchIds	array	Não	A lista de IDs de vSwitch.
	string	Não	O ID do vSwitch. Você pode especificar até 20 IDs de vSwitch.	vsw-p0w9s2ig1jnwgrbzl****
PeerTransitRouterMulticastDomains	array	Não	A lista de IDs de domínios multicast entre regiões.
	string	Não	O ID do domínio multicast entre regiões. Você pode especificar até 20 IDs de domínios multicast entre regiões.	tr-mcast-domain-91wpg6wbhchjeq****
ResourceType	string	Não	O tipo do recurso multicast. Valores válidos: VPC: consulta recursos multicast em uma nuvem privada virtual (VPC). TR: consulta recursos multicast entre regiões.	VPC
ResourceId	string	Não	O ID do recurso associado ao recurso multicast.	vpc-p0w9alkte4w2htrqe****
MaxResults	integer	Não	O número de entradas por página para uma consulta paginada. Valor padrão: 20.	20
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Você não precisa especificar este parâmetro na primeira solicitação ou se não existir uma próxima consulta. Se existir uma próxima consulta, defina o valor como o valor NextToken retornado pela chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****
IsGroupSource	boolean	Não	Especifica se devem ser consultadas fontes multicast. Valores válidos: false: não. true: sim. Nota Este parâmetro é usado em conjunto com IsGroupMember. Se nenhum dos parâmetros for configurado, tanto as fontes quanto os membros multicast serão consultados por padrão. Se apenas um parâmetro for configurado ou ambos forem configurados, a consulta será baseada nos parâmetros configurados.	true
IsGroupMember	boolean	Não	Especifica se devem ser consultados membros multicast. Valores válidos: false: não. true: sim. Nota Este parâmetro é usado em conjunto com IsGroupSource. Se nenhum dos parâmetros for configurado, tanto as fontes quanto os membros multicast serão consultados por padrão. Se apenas um parâmetro for configurado ou ambos forem configurados, a consulta será baseada nos parâmetros configurados.	false
NetworkInterfaceIds	array	Não	A lista de IDs de interface de rede elástica (ENI).
	string	Não	O ID da interface de rede elástica (ENI). Você pode especificar até 20 IDs de interface de rede elástica (ENI).	eni-p0weuda3lszwzjly****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	FB3C4A16-0933-5850-9D43-0C3EA37BCBFB
TotalCount	integer	O número total de entradas retornadas.	1
MaxResults	integer	O número de entradas por página.	20
NextToken	string	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Se NextToken estiver vazio, não existe uma próxima consulta. Se NextToken for retornado, o valor indica o token para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastGroups	array<object>	A lista de informações de grupos multicast.
	object	As informações do grupo multicast.
GroupIpAddress	string	O endereço IP do grupo multicast ao qual o recurso multicast pertence.	239.XX.XX.2
TransitRouterAttachmentId	string	O ID da conexão da instância de rede.	tr-attach-g3kz2k3u76amsk****
VSwitchId	string	O ID do vSwitch ao qual o recurso multicast pertence.	vsw-p0w9s2ig1jnwgrbzl****
NetworkInterfaceId	string	O ID da interface de rede elástica (ENI), que é o ID do recurso multicast.	eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomainId	string	O ID do domínio multicast associado ao recurso multicast entre regiões.	tr-mcast-domain-91wpg6wbhchjeq****
Status	string	O status do recurso multicast. Valores válidos: Registering: sendo criado. Registered: disponível. Deregistering: sendo excluído.	Registered
GroupSource	boolean	Indica se o recurso multicast atual é uma fonte multicast. Valores válidos: true: O recurso multicast é uma fonte multicast. false: O recurso multicast não é uma fonte multicast.	false
GroupMember	boolean	Indica se o recurso multicast atual é um membro multicast. Valores válidos: true: O recurso multicast é um membro multicast. false: O recurso multicast não é um membro multicast.	true
MemberType	string	O tipo do membro multicast. Valores válidos: Static: O membro multicast foi especificado manualmente. IGMPv2: O membro multicast ingressou dinamicamente no grupo multicast através do protocolo IGMP.	Static
SourceType	string	O tipo da fonte multicast. Valores válidos: Static: A fonte multicast foi especificada manualmente. IGMPv2: A fonte multicast ingressou dinamicamente no grupo multicast através do protocolo IGMP.	Static
ResourceType	string	O tipo do recurso multicast. Valores válidos: VPC: O recurso multicast é um recurso em uma VPC. TR: O recurso multicast é um recurso entre regiões.	VPC
ResourceOwnerId	integer	O ID da conta Alibaba Cloud à qual o recurso multicast pertence.	11081188765****
ResourceId	string	O ID do recurso associado ao recurso multicast.	vpc-p0w9alkte4w2htrqe****
TransitRouterMulticastDomainId	string	O ID do domínio multicast.	tr-mcast-domain-kx0vk0v7fz8kx4****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "FB3C4A16-0933-5850-9D43-0C3EA37BCBFB",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastGroups": [
    {
      "GroupIpAddress": "239.XX.XX.2",
      "TransitRouterAttachmentId": "tr-attach-g3kz2k3u76amsk****",
      "VSwitchId": "vsw-p0w9s2ig1jnwgrbzl****",
      "NetworkInterfaceId": "eni-p0weuda3lszwzjly****",
      "PeerTransitRouterMulticastDomainId": "tr-mcast-domain-91wpg6wbhchjeq****",
      "Status": "Registered",
      "GroupSource": false,
      "GroupMember": true,
      "MemberType": "Static",
      "SourceType": "Static",
      "ResourceType": "VPC",
      "ResourceOwnerId": 0,
      "ResourceId": "vpc-p0w9alkte4w2htrqe****",
      "TransitRouterMulticastDomainId": "tr-mcast-domain-kx0vk0v7fz8kx4****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.NextToken	The specified NextToken is illegal.	O NextToken especificado na solicitação é inválido.
400	IllegalParam.TransitRouterMulticastDomainId	The specified TransitRouterMulticastDomainId is illegal.	O TransitRouterMulticastDomainId especificado na solicitação é inválido.
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	O valor de MaxResults é inválido.
400	IllegalParam.TransitRouterAttachmentId	TransitRouterAttachmentId is illegal.	O TrInstance especificado na solicitação é inválido.
400	InvalidParameter	Invalid parameter.	O parâmetro é inválido.
400	Unauthorized	The AccessKeyId is unauthorized.	A conta não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.