BatchRestartOrDeleteInstances
Função
Essa API é usada para reiniciar ou excluir instâncias em lote.
Quando uma instância estiver sendo reiniciada, as solicitações de recuperação e criação de mensagens do cliente serão rejeitadas.
A exclusão de uma instância excluirá os dados na instância sem nenhum backup. Tenha cuidado ao realizar esta operação.
URI
POST /v2/{project_id}/instances/action
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
instances |
Não |
Array of strings |
Lista dos ID de instância. |
action |
Sim |
String |
Operação a ser executada nas instâncias. O valor pode ser restart ou delete. |
all_failure |
Não |
String |
O valor kafka indica que todas as instâncias do Kafka que não forem criadas serão excluídas. |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
results |
Array of results objects |
Resultado da modificação da instância. |
Exemplos de solicitações
- Reiniciação das instâncias em lote.
POST https://{endpoint}/v2/{project_id}/instances/action { "action" : "restart", "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] }
- Exclusão das instâncias em lote.
POST https://{endpoint}/v2/{project_id}/instances/action { "action" : "delete", "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] }
- Exclusão de todas as instâncias de Kafka que não foram criadas.
POST https://{endpoint}/v2/{project_id}/instances/action { "action" : "delete", "all_failure" : "kafka" }
Exemplo de respostas
Código de estado: 200
As instâncias são reiniciadas ou excluídas com êxito.
{ "results" : [ { "result" : "success", "instance" : "019cacb7-4ff0-4d3c-9f33-f5f7b7fdc0e6" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
As instâncias são reiniciadas ou excluídas com êxito. |
Códigos de erro
Consulte Códigos de erro.