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

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

update

*Topic

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

Nenhuma

Sintaxe da solicitação

PATCH /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 que contém o tópico.	rmq-cn-7e22ody****
topicName	string	Sim	O nome do tópico.	topic_test

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.
remark	string	Não	As observações atualizadas do tópico.	This is the remark for test.
maxSendTps	integer	Não	O número máximo de transações por segundo (TPS) para o envio de mensagens.	1000
liteTopicExpiration	integer	Não	O tempo de expiração de um tópico lite, em minutos. Valores válidos: 15 a 720. O valor padrão é -1, o que indica que o tópico nunca expira.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Resultado.
requestId	string	O ID da solicitação. Este ID é único 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	boolean	O resultado retornado.	true
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": true,
  "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.