ConsumerGroupHeartBeat - Simple Log Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Descrição da API

O Host consiste em um nome de projeto e um endpoint do Simple Log Service. Você deve especificar o projeto no Host.
Um consumidor envia heartbeats para o servidor em intervalos fixos para manter sua conexão. Se o servidor não receber um heartbeat do consumidor dentro de um período especificado, o consumidor será excluído.
Obtenha um par de AccessKey. Para mais informações, consulte Par de AccessKey.

Um par de AccessKey de uma conta Alibaba Cloud tem permissões para todas as operações de API. Isso representa uma grande ameaça à segurança. Recomendamos que você crie e use um usuário RAM para chamar operações de API ou executar O&M de rotina. O usuário RAM deve ter permissões para gerenciar recursos do Simple Log Service. Para mais informações, consulte Criar e autorizar um usuário RAM.

Obtenha o nome do projeto, a região e o nome do Logstore. Para mais informações, consulte Gerenciar um projeto e Gerenciar um Logstore.
Obtenha o nome do grupo de consumidores. Para mais informações, consulte ListConsumerGroup.

Informações de autorização

A tabela a seguir descreve as informações de autorização para esta operação. Adicione essas informações ao elemento Action de uma política RAM para conceder a um usuário RAM ou função RAM as permissões para chamar esta operação de API.

Ação	Recurso em uma política de autorização
`log:ConsumerGroupHeartBeat`	`acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}`

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

log:ConsumerGroupHeartBeat

none

*All Resource

*

log:TLSVersion

Nenhuma

Sintaxe da solicitação

POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
logstore	string	Sim	O nome do Logstore.	ali-test-logstore
consumerGroup	string	Sim	O nome do grupo de consumidores. O nome deve ser exclusivo dentro de um projeto.	consumer_group_test

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
project	string	Sim	O nome do projeto.	ali-test-project
consumer	string	Sim	O consumidor.	consumer_1
body	array	Sim	A lista de IDs de shards que estão sendo consumidos.
	integer	Não	A lista de IDs de shards que estão sendo consumidos.	[0]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	array	A lista de todos os IDs de shards que são consumidos pelo consumidor.
	integer	A lista de todos os IDs de shards que são consumidos pelo consumidor.	[0]

Exemplos

Resposta de sucesso

JSON formato

[
  0
]

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.