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

Atualiza as informações básicas e as especificações de uma instância do Message Queue for Apache RocketMQ.

Descrição da operação

Importante

A OpenAPI do Alibaba Cloud é uma API de plano de controle para gerenciar e consultar recursos em nuvem. Use-a apenas no caminho de controle. Não use esta API no caminho de dados principal para transporte de mensagens, pois isso pode comprometer a confiabilidade do serviço.

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

update

*Instance

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

Nenhuma

Sintaxe da solicitação

PATCH /instances/{instanceId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância a ser atualizada.	rmq-cn-7e22ody****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.
instanceName	string	Não	O nome atualizado da instância.	test_instance
remark	string	Não	A observação atualizada para a instância.	This is the remark for test.
networkInfo	object	Não	As informações de rede atualizadas para a instância.
internetInfo	object	Não	As informações de internet. Este parâmetro é válido apenas se o acesso público estiver ativado para a instância.
ipWhitelist	array	Não	The IP address whitelist for public access. If you do not configure an IP address whitelist, the instance allows access from any public IP address by default. If you configure an IP address whitelist, only IP addresses in the whitelist can access the instance over the internet.
	string	Não	An IP address or CIDR block in the public IP address whitelist.	192.168.x.x/24
productInfo	object	Não	A configuração estendida da instância.
sendReceiveRatio	number	Não	A proporção de envio/recebimento de mensagens. Valores válidos: [0.25, 1].	0.5
autoScaling	boolean	Não	Especifica se o desempenho expansível deve ser ativado para a instância. Se você ativar o desempenho expansível, a instância poderá exceder sua linha de base de transações por segundo (TPS) dentro de um intervalo específico. Você será cobrado pelo TPS que exceder a linha de base. Para obter mais informações sobre cobrança, consulte Taxas de capacidade de computação. Nota O desempenho expansível é suportado apenas por edições específicas de instâncias. Para obter mais informações sobre as edições de instâncias suportadas, consulte Edições de instâncias. Valores válidos: true : Ativa o desempenho expansível. false : Desativa o desempenho expansível.	true
messageRetentionTime	integer	Não	O período de retenção de mensagens. Unidade: horas. Para obter informações sobre o intervalo de valores, consulte a seção "Período de retenção de mensagens" no tópico Limites. O armazenamento de mensagens no Message Queue for Apache RocketMQ é serverless e elástico. Você é cobrado pelo uso real de armazenamento. Você pode alterar o período de retenção de mensagens para ajustar sua capacidade de armazenamento. Para obter mais informações, consulte Taxas de armazenamento.	72
traceOn	boolean	Não	Especifica se o recurso de rastreamento de mensagens deve ser ativado. Este parâmetro ainda não está em vigor. O rastreamento de mensagens é ativado por padrão para todas as instâncias. Valores válidos: false : Desativa o recurso de rastreamento de mensagens. true : Ativa o recurso de rastreamento de mensagens.	true
aclInfo	object	Não	As informações de controle de acesso.
aclTypes	array	Não	Os mecanismos de autenticação para a instância.
	string	Não	O mecanismo de autenticação para a instância. Valores válidos: default : Autenticação inteligente. apache_acl : ACL do Apache RocketMQ.	apache_acl
defaultVpcAuthFree	boolean	Não	Especifica se o acesso sem senha por VPCs deve ser ativado quando a autenticação inteligente é usada. Valores válidos: true : Ativa o acesso sem senha. false : Desativa o acesso sem senha.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
requestId	string	O ID exclusivo da solicitação, usado para solucionar e rastrear problemas.	AA87DE09-DA44-52F4-9515-78B1B607****
success	boolean	Indica se a operação foi bem-sucedida.	true
data	boolean	O resultado da operação.	true
code	string	O código de erro.	MissingInstanceId
message	string	A mensagem de erro.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	O código de status HTTP.	400
dynamicCode	string	O código de erro dinâmico.	InstanceId
dynamicMessage	string	A mensagem de erro dinâmica.	instanceId

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

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.