Operations

Obter nós de cluster

GET /clusters/{cluster}/nodes

Parameters

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

Responses

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

Exemplo de solicitação HTTP

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

Esta operação adiciona novos nós de uma matriz de nó 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 controlar o status da operação.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeCreationResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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 deslocaliza nós em um cluster. Você pode identificar os nós usando vários métodos, incluindo nome do nó, ID do nó ou um filtro.

Parameters

Tipo	Name	Description	Schema
Path	cluster required	O cluster onde você deseja desalocar nós	cadeia (de caracteres)
Body	action required	Descrição de quais nós devem ser desalocados	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeManagementResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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

Esta 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 terminados, 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 onde você deseja remover nós	cadeia (de caracteres)
Body	action required	Descrição de quais nós remover	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeManagementResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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

Esta operação encerra 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 estiver definido como Terminate (o padrão), a operação encerrará o nó. Se o atributo estiver definido como Deallocate, a operação deslocaliza o nó.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeManagementResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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

Esta operação inicia nós em um cluster. Você pode identificar os nós pelo 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 (de caracteres)
Body	action required	Descrição de quais nós iniciar	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeManagementResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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

Esta 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 onde você deseja encerrar nós	cadeia (de caracteres)
Body	action required	Descrição de quais nós devem ser encerrados	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeManagementResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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 o cluster de acordo com o tamanho

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

Description

Esta 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 nós novamente 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 (de caracteres)
Path	nodearray required	A matriz de nós à qual adicionar nós	cadeia (de caracteres)
Query	totalCoreCount optional	O número total de núcleos nessa matriz de nós, incluindo nós que você já criou	número inteiro
Query	totalNodeCount optional	O número total de máquinas nessa matriz de nós, incluindo nós que você já criou	número inteiro

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (string) : O URL para a operação.	NodeCreationResult
409	Invalid input	No Content

Exemplo de solicitação HTTP

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

Esta operação retorna informações para os nós e matrizes de nós em um cluster. Para cada matriz de nó, ele 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ó. O provedor de nuvem determina os limites.

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	ClusterStatus

Exemplo de solicitação HTTP

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 retornar dados de uso para	cadeia (de caracteres)
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 para a semana atual (a partir de domingo). custom requer parâmetros de consulta 'de' e 'para'. O padrão é MonthToDate. Todas as horas estão em UTC.	enum (monthToDate, lastMonth, weekToDate, personalizado)
Query	from optional	Para períodos de tempo personalizados, o início do período no formato ISO-8601. O valor é arredondado para baixo para a hora ou dia mais próximo.	cadeia (de caracteres)
Query	to optional	Para períodos de tempo personalizados, use o final do período no formato ISO-8601. O valor arredonda para a hora ou dia mais próximo.	cadeia (de caracteres)
Query	granularity optional	Especifica como agregar dados: por hora, por dia ou como um único número. O padrão é diário.	Enum (total, diário, horário)

Responses

HTTP Code	Description	Schema
200	OK	ClusterUsage

Exemplo de solicitação HTTP

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	O ID da solicitação para a operação. Se você fornecer essa ID, a lista conterá zero ou um elemento.	cadeia (de caracteres)

Responses

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

Exemplo de solicitação HTTP

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	O ID da operação	cadeia (de caracteres)

Responses

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

Exemplo de solicitação HTTP

Request path

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

Exemplo de resposta HTTP

Response 200

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

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	número inteiro
maxCount required	O número máximo de nós que você pode adicionar a esse cluster. Example : 4	número 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 (de caracteres)
targetState optional	O estado desejado do cluster (por exemplo, Iniciado ou Encerrado) Example : "Started"	cadeia (de caracteres)

nodearrays

Name	Description	Schema
buckets required	Cada bucket de alocação para essa matriz de nó. 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ó Example : 16	número inteiro
maxCount required	O número máximo de nós nesta matriz de nós Example : 4	número inteiro
name required	O nome da matriz do nó Example : "execute"	cadeia (de caracteres)
nodearray required	Os atributos desta matriz de nó 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ó Example : 40	número 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	número 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 nessa matriz de bucket e node. Esse valor é sempre um múltiplo de availableCount. Example : 8	número inteiro
availableCount required	Quantos nós extras você pode criar neste bucket e matriz de nós. Esse valor pode ser menor do que o número obtido quando você subtrai usedCount do maxCount, porque maxCount pode ter um limite global. Example : 2	número inteiro
bucketId required	O identificador para este bucket. Esse valor permanece o mesmo para um determinado bucket em uma matriz de nó, desde que você não exclua o cluster. Example : "00000000-0000-0000-0000-000000000000"	cadeia (de caracteres)
consumedCoreCount required	O número de núcleos para esta família que já estão em uso em toda a região. Example : 2	número inteiro
definition optional	As propriedades desse bucket, usadas para criar nós a partir 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 para esta família que já estão em uso em toda a região. Example : 2	número inteiro
familyQuotaCoreCount optional	O número total de núcleos que você pode começar para esta família nesta região. Esse número pode não ser um múltiplo inteiro de quotaCount. Example : 16	número inteiro
familyQuotaCount optional	O número total de instâncias que você pode iniciar ao definir familyQuotaCoreCount. Example : 4	número inteiro
invalidReason required	Se valid for false, o campo conterá o motivo pelo qual o bucket é inválido. Atualmente, NotActivated e DisabledMachineType são os únicos motivos. Example : "DisabledMachineType"	cadeia (de caracteres)
lastCapacityFailure required	Quanto tempo, em segundos, desde a última vez que este 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 nodearray. Sempre um múltiplo de maxCount. Example : 16	número inteiro
maxCount required	O número máximo de nós que podem estar nesse bucket, incluindo limites globais e nodearray Example : 4	número inteiro
maxPlacementGroupCoreSize required	O número total máximo de núcleos em um grupo de posicionamento para esse bucket. Sempre um múltiplo de maxPlacementGroupSize. Example : 64	número inteiro
maxPlacementGroupSize required	O número total máximo de instâncias em um grupo de posicionamento para esse bucket. Example : 16	número 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 começar para esta família nesta região. Este número tem igualmente em conta a contagem do núcleo das quotas regionais. Esse valor pode não ser um múltiplo inteiro de quotaCount. Example : 16	número inteiro
quotaCount required	O número total de instâncias que você pode iniciar, dado o quotaCoreCount. Example : 4	número inteiro
regionalConsumedCoreCount optional	O número de núcleos que já estão em uso em toda a região. Example : 2	número inteiro
regionalQuotaCoreCount optional	O número total de núcleos que você pode iniciar nesta região. Esse número pode não ser um múltiplo inteiro de regionalQuotaCount. Example : 16	número inteiro
regionalQuotaCount optional	O número total de instâncias que você pode iniciar (dado regionalQuotaCoreCount) Example : 4	número inteiro
valid required	Se verdadeiro, esse bucket representa um bucket atualmente válido para usar para novos nós. Se false, esse bucket representa apenas 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 (de caracteres)

placementGroups

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

virtualMachine

Name	Description	Schema
gpuCount required	O número de GPUs que este tipo de máquina tem Example : 2	número inteiro
infiniband required	Se esta máquina virtual suportar 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 este tipo de máquina tem Example : 16	número inteiro
vcpuCount required	O número de CPUs virtuais para este tipo de máquina Example : 32	número inteiro
vcpuQuotaCount optional	O número de vCPUs que esta máquina usa da cota Example : 2	número inteiro

ClusterUsage

Informações de uso e custo opcionais 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 fim do intervalo (exclusivo) Example : "string"	cadeia (de caracteres)
start required	O início do intervalo (inclusive) Example : "string"	cadeia (de caracteres)
total required	O uso geral para este 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ó principal que não seja de matriz; "nodearray" para um nodearray inteiro Example : "string"	enum (cluster, nó, nodearray)
cost optional	O valor a cobrar por esta utilização, em dólares americanos e a taxas de retalho. Nota: 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 matriz de nó, incluindo horas, contagem de núcleos, prioridade da região e sistema operacional. Example : [ "object" ]	< details> array
hours required	O número de horas-núcleo de uso para esta categoria Example : 0.0	number
node optional	O nome do nó ou matriz de nó para o qual o uso é (ausente para dados no nível de cluster) Example : "string"	cadeia (de caracteres)

details

Name	Description	Schema
core_count optional	O número de núcleos neste tamanho de VM Example : 0.0	number
cost optional	Custo deste 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 operativo Example : "string"	enum (Windows, Linux)
priority optional	Prioridade da VM Sku Example : "string"	enum (Regular, Spot)
region optional	A região onde você instancia o tamanho da VM Example : "string"	cadeia (de caracteres)
vm_size optional	Tamanho do VM Sku Example : "string"	cadeia (de caracteres)

Node

Um registro de nó.

Type : object

NodeCreationRequest

Especifica como adicionar nós a um cluster.

Name	Description	Schema
requestId optional	Token exclusivo opcional fornecido pelo usuário para evitar 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 (de caracteres)
sets required	Uma lista de definições de nó a serem criadas. O pedido 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	número inteiro
definition optional	A definição do bucket a ser usado. A chamada da API de status do cluster fornece essa definição. Se faltar na definição alguns itens fornecidos na chamada de status ou na propriedade bucket inteira, o primeiro bucket que corresponda 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 (de caracteres)
nameOffset optional	Se você fornecer essa propriedade com nameFormat, a propriedade compensa nodeindex para novos nós. Example : 1	número inteiro
nodeAttributes optional	Atributos extras a serem definidos em cada nó desse conjunto Example : "[node](#node)"	Node
nodearray required	O nome dos nós para iniciar a nodearray partir de Example : "execute"	cadeia (de caracteres)
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 (de caracteres)

definition

Name	Description	Schema
machineType optional	Example : "A2"	cadeia (de caracteres)

NodeCreationResult

Name	Description	Schema
operationId required	O ID da operação Example : "00000000-0000-0000-0000-000000000000"	cadeia (de caracteres)
sets required	Uma matriz de conjuntos, na mesma ordem da 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	número inteiro
message optional	Explica por que o sistema não pode adicionar todos os nós solicitados, se presentes Example : "string"	cadeia (de caracteres)

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 um ID de operação, este 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 trata 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 (de caracteres)
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ó para gerenciar Example : [ "id1", "id2" ]	<matriz de cadeia de caracteres >
ip_addresses optional	Uma lista de endereços IP para gerenciar Example : [ "10.0.1.1", "10.1.1.2" ]	<matriz de cadeia de caracteres >
names optional	Uma lista de nomes de nós para gerenciar Example : [ "name1", "name2" ]	<matriz de cadeia de caracteres >
requestId optional	Token exclusivo opcional fornecido pelo usuário para evitar operações duplicadas em caso de erros de comunicação de rede. Se o servidor receber uma solicitação com uma que corresponda a requestId uma ID de solicitação anterior, ele ignorará a solicitação e retornará um erro 409. Example : "00000000-0000-0000-0000-000000000000"	cadeia (de caracteres)

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	O ID desta operação Example : "00000000-0000-0000-0000-000000000000"	cadeia (de caracteres)

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 (de caracteres)
id required	A ID do nó Example : "id1"	cadeia (de caracteres)
name required	O nome do nó Example : "name1"	cadeia (de caracteres)
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 submeteu a operação Example : "2020-01-01T12:34:56Z"	string (date-time)