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

Descrição da operação

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

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:QueryGroupSubDetail

get

Grupo.

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

Grupo.

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

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância à qual o ID do grupo a ser consultado pertence.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	Sim	O ID do grupo a ser consultado.	GID_test_group_id

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada ID de solicitação é único e pode ser usado para solucionar problemas e localizar falhas.	3364E875-013B-442A-BC3C-C1A84DC6****
Data	object	O objeto de dados retornado.
SubscriptionDataList	object
SubscriptionDataList	array<object>	Se os consumidores correspondentes ao ID do grupo estiverem offline, nenhum dado será retornado.
	object
SubString	string	A expressão de assinatura.	*
Topic	string	O tópico assinado.	test-mq_topic
GroupId	string	O ID do grupo a ser consultado.	GID_test_group_id
MessageModel	string	O modo de consumo. Valores válidos: CLUSTERING: assinatura de cluster. BROADCASTING: assinatura de broadcast. Para obter mais informações sobre os modos de consumo, consulte Consumo de cluster e consumo de broadcast.	CLUSTERING
Online	boolean	Indica se os consumidores estão online.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "3364E875-013B-442A-BC3C-C1A84DC6****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "SubString": "*",
          "Topic": "test-mq_topic"
        }
      ]
    },
    "GroupId": "GID_test_group_id",
    "MessageModel": "CLUSTERING",
    "Online": true
  }
}

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.