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

Consulta os tópicos em uma instância especificada.

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

rocketmq:ListTopics

list

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/*

Nenhuma

Sintaxe da solicitação

GET /instances/{instanceId}/topics HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância cujos tópicos você deseja consultar.	rmq-cn-7e22ody****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
filter	string	Não	A condição de filtro. Se você deixar este parâmetro vazio, todos os tópicos na instância serão consultados.	topic_test
pageNumber	integer	Não	O número da página a ser retornada.	1
pageSize	integer	Não	O número de entradas a serem retornadas em cada página.	3
messageTypes	array	Não	Os tipos de mensagem dos tópicos.
	string	Não	O tipo de mensagem dos tópicos a serem consultados. Se você deixar este parâmetro vazio, tópicos de todos os tipos de mensagem serão consultados. Valores válidos: TRANSACTION: mensagem transacional FIFO: mensagem ordenada DELAY: mensagem agendada ou atrasada NORMAL: mensagem normal LITE: tópico leve Valores válidos: TRANSACTION : Mensagem transacional. FIFO : Mensagem ordenada. DELAY : Mensagem agendada e atrasada. NORMAL : Mensagem normal.	NORMAL

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Result<MyPage>
requestId	string	O ID da solicitação. Este ID é exclusivo para cada solicitação e pode ser usado para solucionar problemas.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indica se a solicitação foi bem-sucedida.	true
data	object	Os dados retornados.
pageNumber	integer	O número da página retornada.	1
pageSize	integer	O número de entradas retornadas por página.	3
totalCount	integer	O número total de entradas retornadas.	1
list	array<object>	Os dados paginados.
	object
regionId	string	The ID of the region where the instance resides.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageType	string	The message type of the topic. Valores válidos: TRANSACTION : Transactional message FIFO : Ordered message DELAY : Scheduled and delayed messages NORMAL : Normal message	NORMAL
status	string	The status of the topic. Valores válidos: RUNNING : Running CREATING : Creating	RUNNING
remark	string	The remarks on the topic.	This is the remark for test.
createTime	string	The time when the topic was created.	2022-08-01 20:05:50
updateTime	string	The time when the topic was last modified.	2022-08-01 20:05:50
maxSendTps	integer	The maximum number of messages that can be sent per second.	1000
liteTopicExpiration	integer	The expiration time of the lightweight topic. Unit: minutes.	20
code	string	O código de erro.	Topic.NotFound
message	string	A mensagem de erro.	The topic cannot be found.
httpStatusCode	integer	O código de status HTTP.	400
dynamicCode	string	O código de erro dinâmico.	TopicName
dynamicMessage	string	A mensagem de erro dinâmica.	topicName

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageType": "NORMAL",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxSendTps": 1000,
        "liteTopicExpiration": 20
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

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.