Remoção de um nó
Função
Essa API é usada para remover um nó em um cluster especificado.
O URL para gerenciamento de cluster está no formato https://Endpoint/uri. No URL, uri indica o caminho do recurso, ou seja, o caminho para o acesso à API.
URI
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API. |
|
cluster_id |
Sim |
String |
ID do cluster. Para obter detalhes sobre como obter o valor, consulte Como obter parâmetros no URI da API. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
Content-Type |
Sim |
String |
Tipo de corpo da mensagem (formato). |
|
X-Auth-Token |
Sim |
String |
As solicitações para chamar uma API podem ser autenticadas usando um token ou AK/SK. Se a autenticação baseada em token for usada, esse parâmetro é obrigatório e deve ser definido como um token de usuário. Para obter detalhes, consulte Obtenção de um token de usuário. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
apiVersion |
Não |
String |
Versão da API. O valor é fixado em v3. |
|
kind |
Não |
String |
Tipo de API. O valor é fixado em RemoveNodesTask. |
|
spec |
Sim |
RemoveNodesSpec object |
Informações de configuração. |
|
status |
Não |
TaskStatus object |
Status da tarefa. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
login |
Sim |
Login object |
Modo de logon do nó. O par de chaves ou a senha devem ser usados para o logon. |
|
nodes |
Sim |
Array of NodeItem objects |
Lista de nós a serem operados. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
sshKey |
Não |
String |
Nome do par de chaves usado para logon. |
|
userPassword |
Não |
UserPassword object |
Senha usada para logon do nó. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
username |
Não |
String |
Conta de logon. O padrão é root. |
|
password |
Sim |
String |
Se um nome de usuário e uma senha forem usados para criar um nó, esse campo será blindado no corpo da resposta. Uma senha deve atender aos seguintes requisitos de complexidade:
|
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
apiVersion |
String |
Versão da API. O valor é fixado em v3. |
|
kind |
String |
Tipo de API. O valor é fixado em RemoveNodesTask. |
|
spec |
RemoveNodesSpec object |
Informações de configuração. |
|
status |
TaskStatus object |
Status da tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
login |
Login object |
Modo de logon do nó. O par de chaves ou a senha devem ser usados para o logon. |
|
nodes |
Array of NodeItem objects |
Lista de nós a serem operados. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
sshKey |
String |
Nome do par de chaves usado para logon. |
|
userPassword |
UserPassword object |
Senha usada para logon do nó. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
username |
String |
Conta de logon. O padrão é root. |
|
password |
String |
Se um nome de usuário e uma senha forem usados para criar um nó, esse campo será blindado no corpo da resposta. Uma senha deve atender aos seguintes requisitos de complexidade:
|
Exemplo de solicitações
Remoção de um nó
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove
{
"spec" : {
"login" : {
"sshKey" : "KeyPair-001"
},
"nodes" : [ {
"uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}, {
"uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
} ]
}
}
Exemplo de respostas
Código de status: 200
A tarefa para remover um nó em um cluster especificado é entregue com êxito.
{
"spec" : {
"login" : {
"sshKey" : "KeyPair-001"
},
"nodes" : [ {
"uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}, {
"uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
} ]
},
"status" : {
"jobID" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
}
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
A tarefa para remover um nó em um cluster especificado é entregue com êxito. |
Códigos de erro
Consulte Códigos de erro.