Operations

Obter nós de cluster

GET /clusters/{cluster}/nodes

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster a ser consultado	cadeia
Query	operation optional	Se dado, retorna apenas os nós para esta ID de operação e inclui o atributo de operação no corpo	cadeia
Query	request_id optional	Se dado, retorna apenas os nós para a operação identificada por essa ID de solicitação, e inclui o atributo de operação no corpo	cadeia

Responses

HTTP Code	Description	Schema
200	OK	NodeList
400	Invalid specification	No Content
404	Not found	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes

Exemplo de resposta HTTP

Response 200

{
  "nodes" : [ { } ],
  "operation" : {
    "action" : "string",
    "startTime" : "2020-01-01T12:34:56Z"
  }
}

Criar nós de cluster

POST /clusters/{cluster}/nodes/create

Description

Essa operação adiciona novos nós de uma matriz de nós a um cluster. Ele aceita várias definições de nó em uma única chamada. Ele retorna a URL para a operação que você pode usar para acompanhar o status da operação.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster ao qual adicionar nós	cadeia
Body	nodes required	Conjuntos de nós a serem criados	NodeCreationRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeCreationResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

{
  "requestId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Exemplo de resposta HTTP

Response 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Desalocar nós de cluster

POST /clusters/{cluster}/nodes/deallocate

Description

Esta operação desaloca nós em um cluster. Você pode identificar os nós usando vários métodos, incluindo o nome do nó, a ID do nó ou um filtro.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster em que você deseja desalocar nós	cadeia
Body	action required	Descrição de quais nós desalocar	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeManagementResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/deallocate

Request body

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Exemplo de resposta HTTP

Response 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Encerrar e remover nós de cluster

POST /clusters/{cluster}/nodes/remove

Description

Essa operação remove nós em um cluster. Você pode identificar os nós de várias maneiras, incluindo nome do nó, ID do nó ou usando um filtro. Por padrão, os nós são removidos quando encerrados, a menos que o nó tenha a Fixed propriedade definida como true. Nesse caso, essa chamada age da mesma forma que terminar.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster em que você deseja remover nós	cadeia
Body	action required	Descrição de quais nós remover	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeManagementResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/remove

Request body

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Exemplo de resposta HTTP

Response 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Encerrar ou desalocar nós de cluster

POST /clusters/{cluster}/nodes/shutdown

Description

Essa operação termina ou desaloca nós em um cluster. A operação usa o ShutdownPolicy atributo em cada nó para determinar a ação. Se o atributo for definido como Terminate (o padrão), a operação encerrará o nó. Se o atributo estiver definido como Deallocate, a operação desaloca o nó.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster em que você deseja desligar nós	cadeia
Body	action required	Descrição de quais nós desligar	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeManagementResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/shutdown

Request body

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Exemplo de resposta HTTP

Response 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Iniciar nós de cluster desalocados ou encerrados

POST /clusters/{cluster}/nodes/start

Description

Essa operação inicia nós em um cluster. Você pode identificar os nós por nome do nó, ID do nó ou usando um filtro.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster para iniciar nós em	cadeia
Body	action required	Descrição de quais nós iniciar	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeManagementResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/start

Request body

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Exemplo de resposta HTTP

Response 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Encerrar nós de cluster

POST /clusters/{cluster}/nodes/terminate

Description

Essa operação encerra nós em um cluster. Você pode identificar os nós de várias maneiras, incluindo nome do nó, ID do nó ou usando um filtro.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster em que você deseja encerrar nós	cadeia
Body	action required	Descrição de quais nós serão encerrados	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeManagementResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/nodes/terminate

Request body

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Exemplo de resposta HTTP

Response 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Dimensionar cluster para tamanho

POST /clusters/{cluster}/scale/{nodearray}

Description

Essa operação adiciona nós conforme necessário a uma matriz de nós para atingir uma contagem total. O cluster processa a solicitação uma vez. Ele não adiciona novamente nós mais tarde para manter o número. Você pode dimensionar por núcleos totais ou nós totais, mas não ambos. A operação retorna a URL a ser usada para acompanhar o status da operação.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster ao qual adicionar nós	cadeia
Path	nodearray required	A matriz de nós à qual adicionar nós	cadeia
Query	totalCoreCount optional	O número total de núcleos nesta matriz de nós, incluindo nós que você já criou	inteiro
Query	totalNodeCount optional	O número total de computadores nesta matriz de nós, incluindo nós que você já criou	inteiro

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (cadeia de caracteres) : a URL da operação.	NodeCreationResult
409	Invalid input	No Content

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Exemplo de resposta HTTP

Response 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Obter o status do cluster

GET /clusters/{cluster}/status

Description

Essa operação retorna informações para os nós e matrizes de nós em um cluster. Para cada matriz de nós, ela retorna o status de cada "bucket" de alocação que você pode usar. O status mostra quantos nós estão no bucket e quantos nós mais você pode adicionar. Cada bucket é um conjunto de VMs possíveis com um perfil de hardware específico. Você pode criar essas VMs em um local específico em uma conta de cliente. A definição de cluster do usuário determina os buckets válidos para uma matriz de nós. O provedor de nuvem determina os limites.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster a ser consultado	cadeia
Query	nodes optional	Se for true, a resposta inclui nós e referências de nó	boolean

Responses

HTTP Code	Description	Schema
200	OK	ClusterStatus

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/status

Exemplo de resposta HTTP

Response 200

{
  "maxCoreCount" : 16,
  "maxCount" : 4,
  "nodearrays" : [ "object" ],
  "nodes" : [ { } ],
  "state" : "Starting",
  "targetState" : "Started"
}

Obter informações de uso e custo opcionais para um cluster

GET /clusters/{cluster}/usage

Description

Essa operação retorna dados gerais de uso (horas principais) e dados de custo, se disponíveis, para o cluster, bem como uma divisão por nodearray. Por padrão, ele retorna o valor de uso do mês atual.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster para o qual retornar dados de uso	cadeia
Query	timeframe optional	O intervalo de tempo para a consulta. monthToDate retorna o uso do mês atual e lastMonth retorna o uso do mês anterior. weekToDate retorna o uso da semana atual (a partir de domingo). custom requer 'from' e 'to' parâmetros de consulta. O padrão é MonthToDate. Todas as horas estão no padrão UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Para quadros de tempo personalizados, o início do período no formato ISO-8601. O valor é arredondado para a hora ou o dia mais próximo.	cadeia
Query	to optional	Para quadros de tempo personalizados, use o final do período no formato ISO-8601. O valor é arredondado para a hora ou o dia mais próximo.	cadeia
Query	granularity optional	Especifica como agregar dados: por hora, por dia ou como um único número. O padrão é diário.	enumeração (total, diariamente, por hora)

Responses

HTTP Code	Description	Schema
200	OK	ClusterUsage

Solicitação HTTP de exemplo

Request path

/clusters/CLUSTER_NAME/usage

Exemplo de resposta HTTP

Response 200

{
  "usage" : [ "object" ]
}

Lista o status das operações

GET /operations/

Parameters

Tipo	Name	Description	Schema
Query	request_id optional	A ID da solicitação da operação. Se você fornecer essa ID, a lista conterá zero ou um elemento.	cadeia

Responses

HTTP Code	Description	Schema
200	OK	< OperationStatus> array
400	Invalid request	No Content
404	Not found	No Content

Solicitação HTTP de exemplo

Request path

/operations/

Exemplo de resposta HTTP

Response 200

[ {
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
} ]

Obtém o status da operação por ID

GET /operations/{id}

Parameters

Tipo	Name	Description	Schema
Path	id required	A ID da operação	cadeia

Responses

HTTP Code	Description	Schema
200	OK	OperationStatus
404	Not found	No Content

Solicitação HTTP de exemplo

Request path

/operations/00000000-0000-0000-0000-000000000000

Exemplo de resposta HTTP

Response 200

{
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
}

Resources

ClusterStatus

Status do cluster.

Name	Description	Schema
maxCoreCount required	O número máximo de núcleos que você pode adicionar a esse cluster. Example : `16`	inteiro
maxCount required	O número máximo de nós que você pode adicionar a esse cluster. Example : `4`	inteiro
nodearrays required	Example : `[ "object" ]`	< nodearrays> array
nodes optional	Uma lista opcional de nós neste cluster. A resposta inclui essa lista somente se você definir `nodes=true` na consulta. Example : `[ "[node](#node)" ]`	< Node> array
state optional	O estado atual do cluster, se o cluster tiver sido iniciado pelo menos uma vez Example : `"Starting"`	cadeia
targetState optional	O estado desejado do cluster (por exemplo, Iniciado ou Encerrado) Example : `"Started"`	cadeia

nodearrays

Name	Description	Schema
buckets required	Cada bucket de alocação para essa matriz de nós. As configurações de "contagem de núcleos" são sempre um múltiplo da contagem de núcleos para esse bucket. Example : `[ "object" ]`	< buckets> array
maxCoreCount required	O número máximo de núcleos nesta matriz de nós Example : `16`	inteiro
maxCount required	O número máximo de nós nesta matriz de nós Example : `4`	inteiro
name required	O nome da matriz do nó Example : `"execute"`	cadeia
nodearray required	Os atributos dessa matriz de nós Example : `"[node](#node)"`	Node

buckets

Name	Description	Schema
activeCoreCount required	O número de núcleos em uso para este bucket, nesta matriz de nós Example : `40`	inteiro
activeCount required	O número de nós em uso para este bucket, nesta matriz de nós. Essa contagem inclui nós que ainda estão adquirindo uma VM. Example : `10`	inteiro
activeNodes optional	Os nomes de nó em uso para este bucket, nesta matriz de nós. Essa lista inclui nós que ainda estão adquirindo uma VM. A resposta inclui essa propriedade somente se a consulta contiver `nodes=true`. Example : `[ "string" ]`	<matriz de cadeia de caracteres >
availableCoreCount required	Quantos núcleos extras você pode criar neste bucket e na matriz de nós. Esse valor é sempre um múltiplo de `availableCount`. Example : `8`	inteiro
availableCount required	Quantos nós extras você pode criar neste bucket e na matriz de nós. Esse valor pode ser menor do que o número obtido quando você subtrai `usedCountmaxCount`, porque `maxCount` pode ter um limite global. Example : `2`	inteiro
bucketId required	O identificador deste bucket. Esse valor permanece o mesmo para um determinado bucket em uma matriz de nós, desde que você não exclua o cluster. Example : `"00000000-0000-0000-0000-000000000000"`	cadeia
consumedCoreCount required	O número de núcleos dessa família que já estão em uso em toda a região. Example : `2`	inteiro
definition optional	As propriedades desse bucket, usadas para criar nós desse bucket. A API create-nodes usa essa definição em sua `bucket` propriedade. Example : `"object"`	definition
familyConsumedCoreCount optional	O número de núcleos dessa família que já estão em uso em toda a região. Example : `2`	inteiro
familyQuotaCoreCount optional	O número total de núcleos que você pode iniciar para essa família nessa região. Esse número pode não ser um número inteiro múltiplo de quotaCount. Example : `16`	inteiro
familyQuotaCount optional	O número total de instâncias que você pode iniciar ao definir familyQuotaCoreCount. Example : `4`	inteiro
invalidReason required	Se válido for falso, o campo conterá o motivo pelo qual o bucket é inválido. Atualmente, NotActivated e DisabledMachineType são os únicos motivos. Example : `"DisabledMachineType"`	cadeia
lastCapacityFailure required	Quanto tempo, em segundos, desde a última vez em que esse bucket sofreu uma falha de capacidade. Qualquer valor negativo é tratado como nunca. Example : `180.0`	number
maxCoreCount required	O número máximo de núcleos que podem estar nesse bucket, incluindo limites globais e de nodearray. Sempre um múltiplo de maxCount. Example : `16`	inteiro
maxCount required	O número máximo de nós que podem estar neste bucket, incluindo limites globais e de nodearray Example : `4`	inteiro
maxPlacementGroupCoreSize required	O número total máximo de núcleos em um grupo de posicionamento para este bucket. Sempre um múltiplo de `maxPlacementGroupSize`. Example : `64`	inteiro
maxPlacementGroupSize required	O número total máximo de instâncias em um grupo de posicionamento para este bucket. Example : `16`	inteiro
placementGroups required	Os grupos de posicionamento em uso para essa matriz de nós, se houver. Example : `[ "object" ]`	< placementGroups> array
quotaCoreCount required	O número total de núcleos que você pode iniciar para essa família nessa região. Esse número também leva em conta a contagem de núcleos de cota regional. Esse valor pode não ser um múltiplo inteiro de quotaCount. Example : `16`	inteiro
quotaCount required	O número total de instâncias que você pode iniciar, considerando a cotaCoreCount. Example : `4`	inteiro
regionalConsumedCoreCount optional	O número de núcleos que já estão em uso em toda a região. Example : `2`	inteiro
regionalQuotaCoreCount optional	O número de núcleos totais que você pode iniciar nessa região. Esse número pode não ser um múltiplo inteiro de regionalQuotaCount. Example : `16`	inteiro
regionalQuotaCount optional	O número total de instâncias que você pode iniciar (dado regionalQuotaCoreCount) Example : `4`	inteiro
valid required	Se for true, esse bucket representará um bucket atualmente válido a ser usado para novos nós. Se for falso, esse bucket representará somente nós existentes. Example : `true`	boolean
virtualMachine required	As propriedades das máquinas virtuais que você inicia a partir deste bucket Example : `"object"`	virtualMachine

definition

Name	Description	Schema
machineType required	O tamanho da VM da máquina virtual Example : `"A2"`	cadeia

placementGroups

Name	Description	Schema
activeCoreCount required	O número de núcleos neste conjunto de dimensionamento Example : `16`	inteiro
activeCount required	O número de nós neste conjunto de dimensionamento Example : `4`	inteiro
name required	O identificador exclusivo desse grupo de posicionamento Example : `"my-placement-group"`	cadeia

virtualMachine

Name	Description	Schema
gpuCount required	O número de GPUs que esse tipo de computador tem Example : `2`	inteiro
infiniband required	Se essa máquina virtual der suporte à conectividade infiniBand Example : `true`	boolean
memory required	A RAM nesta máquina virtual, em GB Example : `7.5`	number
pcpuCount required	O número de CPUs físicas que esse tipo de computador tem Example : `16`	inteiro
vcpuCount required	O número de CPUs virtuais para esse tipo de computador Example : `32`	inteiro
vcpuQuotaCount optional	O número de vCPUs que este computador usa da cota Example : `2`	inteiro

ClusterUsage

Informações de uso e custo opcional para o cluster

Name	Description	Schema
usage required	Uma lista de usos por intervalo de tempo Example : `[ "object" ]`	< usage> array

usage

Name	Description	Schema
breakdown required	A divisão do uso neste intervalo, por categoria de "nó" e "nodearray" Example : `[ "[clusterusageitem](#clusterusageitem)" ]`	< ClusterUsageItem> array
end required	O final do intervalo (exclusivo) Example : `"string"`	cadeia
start required	O início do intervalo (inclusivo) Example : `"string"`	cadeia
total required	O uso geral desse cluster neste intervalo, com uma categoria de "cluster" Example : `"[clusterusageitem](#clusterusageitem)"`	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"cluster" para o uso geral; "nó" para um único nó de cabeçalho não matriz; "nodearray" para uma nodearray inteira Example : `"string"`	enum (cluster, nó, nodearray)
cost optional	O valor a ser cobrado por esse uso, em dólares americanos e a taxas de varejo. Observação: todos os valores de custo são estimativas e não refletem a fatura real! Example : `0.0`	number
details optional	Detalhes do tamanho da VM usado por uma nodearray, incluindo horas, contagem de núcleos, prioridade de região e sistema operacional. Example : `[ "object" ]`	< details> array
hours required	O número de horas principais de uso para essa categoria Example : `0.0`	number
node optional	O nome da matriz de nó ou nó para o qual o uso é (ausente para dados no nível do cluster) Example : `"string"`	cadeia

details

Name	Description	Schema
core_count optional	O número de núcleos nesse tamanho de VM Example : `0.0`	number
cost optional	Custo desse tamanho de VM Example : `0.0`	number
hours optional	O número de horas principais de uso para esse tamanho de VM Example : `0.0`	number
os optional	Tipo de sistema operacional Example : `"string"`	enum (Windows, Linux)
priority optional	Prioridade do SKU da VM Example : `"string"`	enum (Regular, Spot)
region optional	A região em que você cria uma instância do tamanho da VM Example : `"string"`	cadeia
vm_size optional	Tamanho do SKU da VM Example : `"string"`	cadeia

Node

Um registro de nó.

Type : object

NodeCreationRequest

Especifica como adicionar nós a um cluster.

Name	Description	Schema
requestId optional	Token exclusivo fornecido pelo usuário opcional para impedir operações duplicadas em caso de erros de comunicação de rede. Se o servidor receber uma solicitação com uma `requestId` que corresponda a uma solicitação anterior, ele ignorará a solicitação e retornará um erro 409. Example : `"00000000-0000-0000-0000-000000000000"`	cadeia
sets required	Uma lista de definições de nó a serem criadas. A solicitação deve conter pelo menos um conjunto. Cada conjunto pode especificar um conjunto diferente de propriedades. Example : `[ "object" ]`	< sets> array

sets

Name	Description	Schema
count required	O número de nós a serem criados Example : `1`	inteiro
definition optional	A definição do bucket a ser usado. A chamada à API de status do cluster fornece essa definição. Se a definição estiver faltando alguns itens fornecidos na chamada de status ou em toda a propriedade bucket, o primeiro bucket que corresponde aos itens fornecidos será usado. Example : `"object"`	definition
nameFormat optional	Se você fornecer esse valor, os nós usarão essa convenção de nomenclatura em vez do formato padrão `nodearray-%d` Example : `"custom-name-%d"`	cadeia
nameOffset optional	Se você fornecer essa propriedade `nameFormat`, a propriedade será compensada `nodeindex` para novos nós. Example : `1`	inteiro
nodeAttributes optional	Atributos extras a serem definidos em cada nó neste conjunto Example : `"[node](#node)"`	Node
nodearray required	O nome dos `nodearray` nós de início Example : `"execute"`	cadeia
placementGroupId optional	Se você fornecer essa propriedade, os nós com o mesmo valor para `groupId` todos começarão no mesmo grupo de posicionamento. Example : `"string"`	cadeia

definition

Name	Description	Schema
machineType optional	Example : `"A2"`	cadeia

NodeCreationResult

Name	Description	Schema
operationId required	A ID da operação Example : `"00000000-0000-0000-0000-000000000000"`	cadeia
sets required	Uma matriz de conjuntos, na mesma ordem que na solicitação Example : `[ "object" ]`	< sets> array

sets

Name	Description	Schema
added required	O número de nós a serem adicionados no conjunto Example : `1`	inteiro
message optional	Explica por que o sistema não pode adicionar todos os nós solicitados, se presente Example : `"string"`	cadeia

NodeList

Resultados de uma pesquisa de nó

Name	Description	Schema
nodes required	Os nós que o sistema retorna Example : `[ "[node](#node)" ]`	< Node> array
operation optional	Se a consulta incluir uma ID de operação, esse campo mostrará o status dessa operação Example : `"[operationstatus](#operationstatus)"`	OperationStatus

NodeManagementRequest

Especifica como executar ações em nós em um cluster. Você pode especificar nós de várias maneiras. Se você incluir mais de uma maneira, a solicitação tratará a especificação como uma união.

Name	Description	Schema
filter optional	Uma expressão de filtro que corresponde a nós. Observe que as cadeias de caracteres na expressão devem ser citadas corretamente. Example : `"State === \"Started\""`	cadeia
hostnames optional	Uma lista de nomes de host curtos (sem domínio) para gerenciar Example : `[ "hostname1", "hostname2" ]`	<matriz de cadeia de caracteres >
ids optional	Uma lista de IDs de nó a serem gerenciadas Example : `[ "id1", "id2" ]`	<matriz de cadeia de caracteres >
ip_addresses optional	Uma lista de endereços IP a serem gerenciados Example : `[ "10.0.1.1", "10.1.1.2" ]`	<matriz de cadeia de caracteres >
names optional	Uma lista de nomes de nó a serem gerenciados Example : `[ "name1", "name2" ]`	<matriz de cadeia de caracteres >
requestId optional	Token exclusivo fornecido pelo usuário opcional para impedir operações duplicadas em caso de erros de comunicação de rede. Se o servidor receber uma solicitação com uma `requestId` que corresponda a uma ID de solicitação anterior, ele ignorará a solicitação e retornará um erro 409. Example : `"00000000-0000-0000-0000-000000000000"`	cadeia

NodeManagementResult

Name	Description	Schema
nodes required	Uma matriz de informações sobre cada nó que corresponde ao filtro na solicitação de gerenciamento. O status de cada nó indica se a solicitação o afeta. Example : `[ "object" ]`	< nodes> array
operationId required	A ID desta operação Example : `"00000000-0000-0000-0000-000000000000"`	cadeia

nodes

Name	Description	Schema
error optional	Se o status for Erro, a mensagem de erro Example : `"This node must be terminated before it can be removed"`	cadeia
id required	A ID do nó Example : `"id1"`	cadeia
name required	O nome do nó Example : `"name1"`	cadeia
status optional	Um de OK ou Erro Example : `"Error"`	enum (OK, Erro)

OperationStatus

O status da operação do nó.

Name	Description	Schema
action required	Example : `"string"`	enum (create)
startTime required	Quando você enviou a operação Example : `"2020-01-01T12:34:56Z"`	string (date-time)

Comentários

Esta página foi útil?

Last updated on 2025-07-16

Compartilhar via

Operations

Obter nós de cluster

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Exemplo de resposta HTTP

Response 200

Criar nós de cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Desalocar nós de cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Encerrar e remover nós de cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Encerrar ou desalocar nós de cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Iniciar nós de cluster desalocados ou encerrados

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Encerrar nós de cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Request body

Exemplo de resposta HTTP

Response 202

Dimensionar cluster para tamanho

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Exemplo de resposta HTTP

Response 202

Obter o status do cluster

Description

Parameters

Responses

Solicitação HTTP de exemplo

Request path

Exemplo de resposta HTTP

Response 200

Obter informações de uso e custo opcionais para um cluster