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

Descrição da operação

Nota

As operações de API fornecidas pelo Alibaba Cloud são usadas para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Recomendamos que você integre essas operações de API apenas em sistemas de gerenciamento. Não use essas operações de API no sistema principal dos serviços de mensagens. Caso contrário, podem ocorrer riscos ao sistema.

Você pode determinar o uso de recursos de um tópico com base nas informações retornadas por esta operação. As informações retornadas incluem o número total de mensagens no tópico e o momento mais recente em que uma mensagem foi publicada no tópico.

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

get

Topic

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

Topic

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

Nenhuma

mq:OnsInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Topic	string	Sim	O nome do tópico que você deseja consultar.	test
InstanceId	string	Não	O ID da instância que contém o tópico que você deseja consultar.	MQ_INST_188077086902****_BXSuW61e

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A mensagem retornada.
RequestId	string	O ID da solicitação. Este é um parâmetro comum. Cada solicitação possui um ID exclusivo. Você pode usar esse ID para solucionar problemas.	427EE49D-D762-41FB-8F3D-9BAC96C3****
Data	object	A estrutura de dados do tópico consultado.
Perm	integer	Indica as operações que você pode realizar no tópico. Valores válidos: 2: Você pode publicar mensagens no tópico. 4: Você pode assinar o tópico. 6: Você pode publicar mensagens e assinar o tópico.	6
LastTimeStamp	integer	O momento em que a mensagem mais recente fica pronta no tópico. Se não houver mensagens no tópico, o valor de retorno deste parâmetro será 0. O valor deste parâmetro é um timestamp UNIX em milissegundos. Para obter informações sobre a definição de mensagens prontas e tempo de prontidão, consulte Termos.	1570864984364
TotalCount	integer	O número total de mensagens em todas as partições do tópico.	2310

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****",
  "Data": {
    "Perm": 6,
    "LastTimeStamp": 1570864984364,
    "TotalCount": 2310
  }
}

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.