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

Obtém os detalhes de um tópico especificado.

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

get

*Topic

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância à qual o tópico pertence.	rmq-cn-7e22ody****
topicName	string	Sim	O nome do tópico a ser consultado.	topic_test.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Result
requestId	string	O ID da solicitação. Cada solicitação possui um ID exclusivo, que pode ser usado para solucionar problemas.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indica se a operação foi bem-sucedida.	true.
data	object	Os dados da resposta.
regionId	string	O ID da região da instância.	cn-hangzhou.
instanceId	string	O ID da instância à qual o tópico pertence.	rmq-cn-7e22ody****
topicName	string	O nome do tópico.	topic_test.
messageType	string	O tipo de mensagem do tópico. Valores válidos: TRANSACTION : Mensagem transacional. FIFO : Mensagem ordenada. DELAY : Mensagem agendada ou mensagem atrasada. NORMAL : Mensagem normal. LITE : Mensagem de tópico Lite.	NORMAL.
status	string	O status do tópico. Valores válidos: RUNNING: Em execução. CREATING: Sendo criado. Valores válidos: RUNNING : Em execução. CREATING : Sendo criado.	RUNNING.
remark	string	As observações do tópico.	Esta é a observação para teste.
createTime	string	A hora em que o tópico foi criado.	2022-08-01 20:05:50
updateTime	string	A hora em que o tópico foi modificado pela última vez.	2022-08-01 20:05:50
maxSendTps	integer	O número máximo de transações por segundo (TPS) para envio de mensagens.	1000
liteTopicExpiration	integer	O tempo de expiração do tópico Lite. Unidade: minutos.	60
priority	integer		9
code	string	O código de erro.	Topic.NotFound.
message	string	A mensagem de erro.	O tópico não foi encontrado.
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": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageType": "NORMAL",
    "status": "RUNNING",
    "remark": "This is the remark for test.\n",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "maxSendTps": 1000,
    "liteTopicExpiration": 60,
    "priority": 9
  },
  "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.