Reiniciação ou exclusão das instâncias em lote
Esta API está desatualizada e pode não ser mantida no futuro. Use a API descrita em Reiniciação ou exclusão das instâncias em lote.
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.
Solicitação
Parâmetros de solicitação
Tabela 2 descreve os parâmetros.
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|---|---|---|---|
action |
String |
Sim |
Indica a operação a ser executada nas instâncias. O valor deste parâmetro pode ser restart ou delete. |
instances |
Array |
Não |
Indica a lista dos ID de instância. |
allFailure |
String |
Não |
Quando definido como kafka, indica que todas as instâncias de Kafka que não forem criadas serão excluídas. |
Exemplos de solicitações
Reiniciação das instâncias em lote
POST https://{dms_endpoint}/v1.0/{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://{dms_endpoint}/v1.0/{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://{dms_endpoint}/v1.0/{project_id}/instances/action
{
"action" : "delete",
"allFailure" : "kafka"
}
Resposta
Parâmetros de resposta
Quando action é definida como delete, allFailure é definida como kafka e uma resposta vazia é retornada, as instâncias são excluídas com sucesso. Tabela 3 descreve os parâmetros.
Parâmetro |
Tipo |
Descrição |
|---|---|---|
results |
Array |
Indica o resultado da modificação da instância. |
Parâmetro |
Tipo |
Descrição |
|---|---|---|
instance |
String |
Indica o ID da instância. |
result |
String |
Indica um resultado da operação, que pode ser success ou failed |
Exemplo de respostas
{
"results": [
{
"result": "success",
"instance": "afc90a2a-a02c-4cba-94d5-58dfa9ad1e0d"
},
{
"result": "success",
"instance": "67fc5f8d-3986-4f02-bb75-4075a23112de"
}
]
}
Código de status
Tabela 5 descreve o código de status das operações sucedidas. Para obter detalhes sobre outros códigos de status, consulte Código de status.
