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

A OpenAPI do Alibaba Cloud é uma API de gerenciamento usada para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre a OpenAPI apenas em links de dados de gerenciamento. Não dependa da OpenAPI em links de dados principais para envio e recebimento de mensagens, pois isso pode criar ameaças aos seus links de dados.

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

Group

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 à qual os Group IDs pertencem.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	Não	Especifique um Group ID para realizar uma consulta difusa. Se você deixar este parâmetro vazio, todos os Group IDs serão consultados. Se você inserir GID_ABC, uma consulta difusa será realizada correspondendo prefixos e sufixos. Todos os Group IDs que contêm GID_ABC são retornados, como GID_test_GID_ABC_123 e GID_ABC_356.	GID_test_group_id
GroupType	string	Não	O protocolo que os Group IDs consultados suportam. Group IDs para o protocolo TCP e o protocolo HTTP não podem ser compartilhados. Você deve criá-los separadamente. Valores válidos: tcp: Este é o valor padrão. Indica que o Group ID se aplica apenas ao envio e recebimento de mensagens pelo protocolo TCP. http: Indica que o Group ID se aplica apenas ao envio e recebimento de mensagens pelo protocolo HTTP.	tcp
Tag	array<object>	Não	A lista de tags anexadas ao Group ID. O número de elementos na lista não pode exceder 20.
	object	Não
Key	string	Sim	A chave da tag do Group ID. Especifique Key e Value, ou deixe ambos vazios. Se ambos forem especificados, o sistema filtrará os Group IDs correspondentes. Se ambos forem deixados vazios, todos os Group IDs serão consultados. Se você especificar este parâmetro, seu valor não poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	CartService
Value	string	Sim	O valor da tag do Group ID. Especifique Key e Value, ou deixe ambos vazios. Se ambos forem especificados, o sistema filtrará os Group IDs correspondentes. Se ambos forem deixados vazios, todos os Group IDs serão consultados. Se você especificar este parâmetro, seu valor poderá ser uma string vazia. O valor pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	ServiceA

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação tem um ID exclusivo. Você pode usar este ID para solucionar problemas.	16996623-AC4A-43AF-9248-FD9D2D75****
Data	object
SubscribeInfoDo	array<object>	O conjunto de relações de assinatura retornadas.
	array<object>
Owner	string	The owner of the publish information.	138015630679****
UpdateTime	integer	The time when the Group ID was updated.	1570700979000
IndependentNaming	boolean	Indicates whether the instance has a namespace. Valid values: true: The instance has an independent namespace. The resource name must be unique within the instance. The resource name can be the same across instances. false: The instance does not have an independent namespace. The resource name must be globally unique within or across instances.	true
GroupId	string	The Group ID, which is the ID of the consumer group.	GID_test_group_id
Remark	string	The remarks.	test
CreateTime	integer	The time when the Group ID was created.	1568896605000
Tags	object
Tag	array<object>	The tags that are attached to the Group ID.
	object
Key	string	The tag key.	CartService
Value	string	The tag value.	ServiceA
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
GroupType	string	The protocol that the queried Group IDs support. Group IDs for the TCP protocol and the HTTP protocol cannot be shared. You must create them separately. Valid values: tcp: Indicates that the Group ID applies only to sending and receiving messages over the TCP protocol. http: Indicates that the Group ID applies only to sending and receiving messages over the HTTP protocol.	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.