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

Descrição da operação

Importante A OpenAPI fornecida pela Alibaba Cloud é uma API de gerenciamento e controle usada para gerenciar e consultar recursos dos serviços da Alibaba Cloud. É recomendada apenas para integração em links de gerenciamento e controle. Não use a OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, podem ocorrer riscos no link de dados.

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

update

*Grupo de consumidores.

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

Nenhuma

Sintaxe da solicitação

PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId} 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 grupo de consumidores a ser atualizado pertence.	rmq-cn-7e22on9****
consumerGroupId	string	Sim	O ID do grupo de consumidores a ser atualizado.	CID-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 grupo de consumidores.	Esta é a observação para teste
deliveryOrderType `deprecated`	string	Não	A modificação não é suportada. Valores válidos: Concurrently : Entrega concorrente. Orderly : Entrega ordenada.	Concurrently
consumeRetryPolicy	object	Sim	A política de nova tentativa de consumo atualizada do grupo de consumidores. Para obter mais informações, consulte Nova tentativa de consumo.
retryPolicy	string	Sim	O tipo de política de nova tentativa. Para obter mais informações, consulte Nova tentativa de mensagem. Valores válidos: FixedRetryPolicy: nova tentativa com intervalo fixo. Apenas a entrega ordenada é suportada. DefaultRetryPolicy: nova tentativa com backoff incremental. Apenas a entrega concorrente é suportada. Valores válidos: FixedRetryPolicy : Nova tentativa com intervalo fixo. DefaultRetryPolicy : Nova tentativa com backoff incremental.	DefaultRetryPolicy
maxRetryTimes	integer	Não	O número máximo de novas tentativas.	16
deadLetterTargetTopic	string	Não	O tópico de mensagens mortas. Se um consumidor falhar ao consumir uma mensagem e a mensagem ainda falhar após as novas tentativas, a mensagem será entregue ao tópico de mensagens mortas para recuperação ou revisão posterior do negócio. Para obter mais informações, consulte Nova tentativa de consumo e mensagens mortas.	DLQ_mqtest
fixedIntervalRetryTime	integer	Não	O intervalo fixo de nova tentativa. Unidade: segundos. Este parâmetro só entra em vigor quando a política de nova tentativa é definida como FixedRetryPolicy (nova tentativa com intervalo fixo). Valores válidos: Entrega concorrente: 10-1800 Entrega ordenada: 1-600	10
maxReceiveTps	integer	Não	O limite superior de TPS para consumo de mensagens.	1000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Result
requestId	string	O ID da solicitação. Cada solicitação tem um ID exclusivo que você pode usar para solucionar e localizar problemas.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indica se a execução foi bem-sucedida.	true
data	boolean	O resultado retornado.	true
code	string	O código de falha.	InvalidDeliveryOrderType
message	string	A mensagem de falha.	O parâmetro deliveryOrderType é inválido
httpStatusCode	integer	O código de status HTTP.	400
dynamicCode	string	O código de falha dinâmico.	DeliveryOrderType
dynamicMessage	string	A mensagem de falha dinâmica.	deliveryOrderType

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": true,
  "code": "InvalidDeliveryOrderType",
  "message": "Parameter deliveryOrderType is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "DeliveryOrderType",
  "dynamicMessage": "deliveryOrderType"
}

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.