OnsGroupList - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Consulta todos os Group IDs de uma instância especificada.

Descrição da operação

Importante As operações OpenAPI fornecidas pela Alibaba Cloud são APIs de gerenciamento usadas para gerenciar e consultar recursos dos serviços da Alibaba Cloud. Integre essas APIs apenas em fluxos de trabalho de gerenciamento. Não dependa de operações OpenAPI no link de dados principal para publicação e consumo de mensagens. Caso contrário, podem ocorrer riscos no link.

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

mq:ListGroup

list

Grupo.

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Nenhuma

mq:QueryInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	O ID da instância correspondente ao Group ID para o qual você deseja recuperar os recursos.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	Não	O Group ID usado para correspondência difusa. Se você especificar este parâmetro, uma correspondência difusa será realizada. Caso contrário, todos os Group IDs serão consultados.\n\nSe você especificar GID_ABC, uma correspondência difusa será realizada e todos os Group IDs que contêm GID_ABC serão retornados, como GID_test_GID_ABC_123 e GID_ABC_356.	GID_test_group_id
GroupType	string	Não	O protocolo aplicável ao Group ID. Group IDs para os protocolos TCP e HTTP não podem ser compartilhados e devem ser criados separadamente. Valores válidos:\n\n- tcp: o valor padrão. Este valor indica que o Group ID é aplicável apenas à publicação e consumo de mensagens via TCP.\n- http: Este valor indica que o Group ID é aplicável apenas à publicação e consumo de mensagens via HTTP.	tcp
Tag	array<object>	Não	As tags vinculadas aos Group IDs. Você pode especificar no máximo 20 tags.
	object	Não
Key	string	Sim	A chave da tag do Group ID. Você deve especificar Key e Value ou deixar ambos vazios. Se você especificar ambos, o sistema filtrará os Group IDs com base na tag. Se você deixar ambos vazios, todos os Group IDs serão consultados.\n\n- Se você especificar este parâmetro, o valor não poderá ser uma string vazia.\n- O valor pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. O valor não pode conter `http://` ou `https://`.	CartService
Value	string	Sim	O valor da tag do Group ID. Você deve especificar Key e Value ou deixar ambos vazios. Se você especificar ambos, o sistema filtrará os Group IDs com base na tag. Se você deixar ambos vazios, todos os Group IDs serão consultados.\n\n- Se você especificar este parâmetro, o valor poderá ser uma string vazia.\n- O valor pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. O valor não pode conter `http://` ou `https://`.	ServiceA

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O parâmetro comum. O ID de cada solicitação é único e ativo para solução de problemas e localização de falhas.	16996623-AC4A-43AF-9248-FD9D2D75****
Data	object
SubscribeInfoDo	array<object>	As relações de assinatura consultadas.
	array<object>
Owner	string	O proprietário das informações de publicação.	138015630679****
UpdateTime	integer	A hora de atualização do Group ID.	1570700979000
IndependentNaming	boolean	Indica se a instância possui um namespace. Valores válidos:\n\n- true: A instância possui um namespace independente. Os nomes dos recursos são exclusivos dentro da instância, mas podem ser duplicados entre instâncias.\n\n- false: A instância não possui um namespace independente. Os nomes dos recursos devem ser globalmente exclusivos dentro e entre as instâncias.	true
GroupId	string	O Group ID, que é o ID do grupo de consumidores.	GID_test_group_id
Remark	string	A descrição.	test
CreateTime	integer	A hora de criação do Group ID.	1568896605000
Tags	object
Tag	array<object>	As tags vinculadas ao Group ID.
	object
Key	string	A chave da tag.	CartService
Value	string	O valor da tag.	ServiceA
InstanceId	string	O ID da instância.	MQ_INST_111111111111_DOxxxxxx
GroupType	string	O protocolo aplicável ao Group ID. Group IDs para os protocolos TCP e HTTP não podem ser compartilhados e devem ser criados separadamente. Valores válidos:\n\n- tcp: Este valor indica que o Group ID é aplicável apenas à publicação e consumo de mensagens via TCP.\n- http: Este valor indica que o Group ID é aplicável apenas à publicação e consumo de mensagens via HTTP.	tcp

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data": {
    "SubscribeInfoDo": [
      {
        "Owner": "138015630679****",
        "UpdateTime": 1570700979000,
        "IndependentNaming": true,
        "GroupId": "GID_test_group_id",
        "Remark": "test",
        "CreateTime": 1568896605000,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "GroupType": "tcp"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.