Operações

Obter nós de cluster

GET /clusters/{cluster}/nodes

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster a consultar	string
Query	operação opcional	Se for dado, devolve apenas os nós deste ID de operação e inclui o atributo de operação no corpo	string
Query	request_id opcional	Se for dada, devolve apenas os nós da operação identificada por este ID de pedido, e inclui o atributo de operação no corpo	string

Respostas

Código HTTP	Description	Esquema
200	OK	NodeList
400	Especificação inválida	Sem Conteúdo
404	Não encontrado	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes

Resposta HTTP de exemplo

Resposta 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 um nóarray a um cluster. Aceita várias definições de nós numa única chamada. Devolve o URL à operação que pode ser utilizada para controlar o estado da operação.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para adicionar nós a	string
Corpo	nós obrigatório	Conjuntos de nós a criar	NodeCreationRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia) : o URL da operação.	NodeCreationResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/create

Corpo do pedido

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

Resposta HTTP de exemplo

Resposta 202

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

Desalocar nós de cluster

POST /clusters/{cluster}/nodes/deallocate

Description

Esta operação desaloca os nós num cluster. Os nós podem ser identificados de várias formas, incluindo o nome do nó, o ID do nó ou por filtro.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para desalocar nós no	string
Corpo	ação necessário	Descrição dos nós a desalocar	NodeManagementRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia) : o URL da operação.	NodeManagementResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/deallocate

Corpo do pedido

{
  "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"
}

Resposta HTTP de exemplo

Resposta 202

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

Terminar e remover nós de cluster

POST /clusters/{cluster}/nodes/remove

Description

Esta operação remove nós num cluster. Os nós podem ser identificados de várias formas, incluindo o nome do nó, o ID do nó ou por filtro. Tenha em atenção que, por predefinição, os nós são removidos quando terminados (a menos que o nó tenha Definido como verdadeiro), caso em que esta chamada não é diferente de terminar.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para remover nós no	string
Corpo	ação obrigatório	Descrição dos nós a remover	NodeManagementRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia): o URL da operação.	NodeManagementResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/remove

Corpo do pedido

{
  "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"
}

Resposta HTTP de exemplo

Resposta 202

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

Terminar ou desalocar nós de cluster

POST /clusters/{cluster}/nodes/shutdown

Description

Esta operação termina ou desaloca nós num cluster, dependendo se o atributo ShutdownPolicy em cada nó é Terminar (a predefinição) ou Desalocar, respetivamente.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para encerrar nós no	string
Corpo	ação necessário	Descrição dos nós a encerrar	NodeManagementRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia): o URL da operação.	NodeManagementResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/shutdown

Corpo do pedido

{
  "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"
}

Resposta HTTP de exemplo

Resposta 202

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

Iniciar nós de cluster desalocados ou terminados

POST /clusters/{cluster}/nodes/start

Description

Esta operação inicia nós num cluster. Os nós podem ser identificados de várias formas, incluindo o nome do nó, o ID do nó ou por filtro.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster no qual iniciar os nós	string
Corpo	ação obrigatório	Descrição dos nós a iniciar	NodeManagementRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia) : o URL da operação.	NodeManagementResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/start

Corpo do pedido

{
  "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"
}

Resposta HTTP de exemplo

Resposta 202

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

Terminar nós de cluster

POST /clusters/{cluster}/nodes/terminate

Description

Esta operação termina os nós num cluster. Os nós podem ser identificados de várias formas, incluindo o nome do nó, o ID do nó ou por filtro.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para terminar nós em	string
Corpo	ação obrigatório	Descrição dos nós a terminar	NodeManagementRequest

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia) : o URL da operação.	NodeManagementResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/nodes/terminate

Corpo do pedido

{
  "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"
}

Resposta HTTP de exemplo

Resposta 202

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

Dimensionar cluster a tamanho

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

Description

Esta operação adiciona nós conforme necessário a um nóarray para atingir uma contagem total. O pedido é processado uma vez e não adiciona novamente nós mais tarde para manter o número especificado. Isto dimensiona por núcleos totais ou nós totais, mas não ambos. Devolve o URL à operação que pode ser utilizada para controlar o estado da operação.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para adicionar nós a	string
Caminho	nóarray obrigatório	O nóarray para adicionar nós a	string
Query	totalCoreCount opcional	O número total de núcleos a ter neste nóarray, incluindo nós já criados	número inteiro
Query	totalNodeCount opcional	O número total de máquinas a ter neste nóarray, incluindo nós já criados	número inteiro

Respostas

Código HTTP	Description	Esquema
202	Aceite Cabeçalhos : Location (cadeia) : o URL da operação.	NodeCreationResult
409	Entrada inválida	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Resposta HTTP de exemplo

Resposta 202

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

Obter estado do cluster

GET /clusters/{cluster}/status

Description

Esta operação contém informações para os nós e os nóarrays num determinado cluster. Para cada nóarray, devolve o estado de cada "registo" de alocação que pode ser utilizado, como quantos nós estão no registo, quantos mais podem ser adicionados, etc. Cada registo é um conjunto de VMs possíveis de um determinado perfil de hardware, que podem ser criadas numa determinada localização, numa determinada conta de cliente, etc. Os registos válidos para um nóarray são determinados pela definição do cluster do utilizador, mas os limites são determinados em parte pelo fornecedor de cloud.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster a consultar	string
Query	nós opcional	Se for verdadeiro, os nós e as referências de nós são devolvidos na resposta	boolean

Respostas

Código HTTP	Description	Esquema
200	OK	ClusterStatus

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/status

Resposta HTTP de exemplo

Resposta 200

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

Obter informações de utilização e custos opcionais para um cluster

GET /clusters/{cluster}/usage

Description

Esta operação devolve dados de utilização geral (horas principais) e dados de custos, se disponíveis, para o cluster, bem como uma discriminação por nóarray. Por predefinição, devolve o valor de utilização do mês atual.

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	cluster obrigatório	O cluster para devolver dados de utilização para	string
Query	período de tempo opcional	Se for indicado, este procedimento especifica o intervalo de tempo a utilizar para a consulta. monthToDate devolve a utilização do mês atual e lastMonth devolve a utilização do mês anterior. weekToDate devolve a utilização da semana atual (a partir de domingo). o personalizado requer parâmetros de consulta "de" e "para". A predefinição é MonthToDate. Todas as horas estão em UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	a partir de opcional	Para intervalos de tempo personalizados, este é o início do período de tempo no formato ISO-8601. Esta ação é arredondada para a hora ou dia mais próximo.	string
Query	para opcional	Para intervalos de tempo personalizados, este é o fim do período de tempo no formato ISO-8601. Esta ação é arredondada até à hora ou dia mais próximo.	string
Query	granularidade opcional	Especifica como agregar dados: por hora, por dia ou como um único número. Esta predefinição é diária.	enum (total, diário, hora a hora)

Respostas

Código HTTP	Description	Esquema
200	OK	ClusterUsage

Pedido HTTP de exemplo

Caminho do pedido

/clusters/CLUSTER_NAME/usage

Resposta HTTP de exemplo

Resposta 200

{
  "usage" : [ "object" ]
}

Listas o estado das operações

GET /operations/

Parâmetros

Tipo	Name	Descrição	Esquema
Query	request_id opcional	O ID do pedido para a operação. Se for dada, a lista terá apenas 0 ou 1 elemento.	string

Respostas

Código HTTP	Description	Esquema
200	OK	<OperationStatus> matriz
400	Pedido inválido	Sem Conteúdo
404	Não encontrado	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

/operations/

Resposta HTTP de exemplo

Resposta 200

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

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

GET /operations/{id}

Parâmetros

Tipo	Name	Descrição	Esquema
Caminho	id necessário	O ID da operação	string

Respostas

Código HTTP	Description	Esquema
200	OK	OperationStatus
404	Não encontrado	Sem Conteúdo

Pedido HTTP de exemplo

Caminho do pedido

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

Resposta HTTP de exemplo

Resposta 200

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

Recursos

ClusterStatus

Estado do cluster

Nome	Descrição	Esquema
maxCoreCount obrigatório	O número máximo de núcleos que podem ser adicionados a este cluster Exemplo : 16	número inteiro
maxCount necessário	O número máximo de nós que podem ser adicionados a este cluster Exemplo : 4	número inteiro
nóarrays necessário	Exemplo : [ "object" ]	<nóarrays> matriz
nós opcional	Uma lista opcional de nós neste cluster, apenas incluída se nós=true estiver na consulta Exemplo : [ "[node](#node)" ]	<> Nó matriz
estado opcional	O estado atual do cluster, se tiver sido iniciado pelo menos uma vez Exemplo : "Starting"	string
targetState opcional	O estado pretendido do cluster (por exemplo, Iniciado ou Terminado) Exemplo : "Started"	string

nóarrays

Nome	Descrição	Esquema
registos necessário	Cada registo de alocação para este nóarray. As definições de "contagem de núcleos" são sempre um múltiplo da contagem de núcleos para este registo. Exemplo : [ "object" ]	<registos> matriz
maxCoreCount obrigatório	O número máximo de núcleos que podem estar neste nóarray Exemplo : 16	número inteiro
maxCount necessário	O número máximo de nós que podem estar neste nóarray Exemplo : 4	número inteiro
nome necessário	O nóarray que isto descreve Exemplo : "execute"	string
nóarray necessário	Os atributos deste nóarray Exemplo : "[node](#node)"	Nó

registos

Nome	Descrição	Esquema
activeCoreCount necessário	O número de núcleos em utilização para este registo, neste nóarray Exemplo : 40	número inteiro
activeCount necessário	O número de nós em utilização para este registo, neste nóarray. Isto inclui nós que ainda estão a adquirir uma VM. Exemplo : 10	número inteiro
activeNodes opcional	Os nomes de nós em utilização para este registo, neste nóarray. Isto inclui nós que ainda estão a adquirir uma VM. Isto só é incluído se nós=true estiverem na consulta. Exemplo : [ "string" ]	<matriz de cadeia >
availableCoreCount necessário	Quantos núcleos adicionais podem ser criados neste registo, neste nóarray. Sempre um múltiplo de availableCount. Exemplo : 8	número inteiro
availableCount necessário	Quantos nós adicionais podem ser criados neste registo, neste nóarray. Tenha em atenção que isto pode ser menor do que o implícito por maxCount e usedCount, uma vez que maxCount pode ser limitado globalmente. Exemplo : 2	número inteiro
bucketId necessário	O identificador deste registo. Este valor terá sempre o mesmo valor para um determinado registo num nóarray, desde que o cluster não seja eliminado. Exemplo : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount obrigatório	O número de núcleos para esta família que já estão a ser utilizados em toda a região. Exemplo : 2	número inteiro
definição opcional	As propriedades deste registo, utilizadas para criar nós a partir deste registo. A API create-nodes utiliza esta definição na respetiva bucket propriedade. Exemplo : "object"	definição
familyConsumedCoreCount opcional	O número de núcleos para esta família que já estão a ser utilizados em toda a região. Exemplo : 2	número inteiro
familyQuotaCoreCount opcional	O número total de núcleos que podem ser iniciados para esta família nesta região. Este pode não ser um número inteiro múltiplo de quotaCount. Exemplo : 16	número inteiro
familyQuotaCount opcional	O número total de instâncias que podem ser iniciadas (dado familyQuotaCoreCount) Exemplo : 4	número inteiro
invalidReason necessário	Se válido for falso, isto conterá o motivo pelo qual o registo é inválido. Atualmente, NotActivated e DisabledMachineType são os únicos motivos. Exemplo : "DisabledMachineType"	string
lastCapacityFailure necessário	Durante quanto tempo, em segundos, desde a última vez que este registo sofreu uma falha de capacidade. Qualquer valor negativo é tratado como nunca. Exemplo : 180.0	número
maxCoreCount necessário	O número máximo de núcleos que podem estar neste registo, incluindo limites globais e de nóarray. Sempre um múltiplo de maxCount. Exemplo : 16	número inteiro
maxCount necessário	O número máximo de nós que podem estar neste registo, incluindo limites globais e de nóarray Exemplo : 4	número inteiro
maxPlacementGroupCoreSize necessário	O número total máximo de núcleos que podem estar num grupo de colocação neste registo. Sempre um múltiplo de maxPlacementGroupSize. Exemplo : 64	número inteiro
maxPlacementGroupSize obrigatório	O número total máximo de instâncias que podem estar num grupo de colocação neste registo Exemplo : 16	número inteiro
placementGroups necessário	Os grupos de colocação em utilização para este nóarray, se existirem. Exemplo : [ "object" ]	<placementGroups> matriz
quotaCoreCount obrigatório	O número total de núcleos que podem ser iniciados para esta família nesta região, tendo em conta também a contagem de núcleos de quota regional. Este pode não ser um número inteiro múltiplo de quotaCount. Exemplo : 16	número inteiro
quotaCount necessário	O número total de instâncias que podem ser iniciadas (dado quotaCoreCount) Exemplo : 4	número inteiro
regionalConsumedCoreCount opcional	O número de núcleos que já estão a ser utilizados em toda a região. Exemplo : 2	número inteiro
regionalQuotaCoreCount opcional	O número total de núcleos que podem ser iniciados nesta região. Este pode não ser um número inteiro múltiplo de regionalQuotaCount. Exemplo : 16	número inteiro
regionalQuotaCount opcional	O número total de instâncias que podem ser iniciadas (tendo em conta regionalQuotaCoreCount) Exemplo : 4	número inteiro
válido necessário	Se for verdadeiro, este registo representa um registo atualmente válido para utilizar para novos nós. Se for falso, este registo representa apenas nós existentes. Exemplo : true	boolean
virtualMachine obrigatório	As propriedades das máquinas virtuais iniciadas a partir deste registo Exemplo : "object"	virtualMachine

definição

Nome	Descrição	Esquema
machineType obrigatório	O tamanho da VM da máquina virtual Exemplo : "A2"	string

placementGroups

Nome	Descrição	Esquema
activeCoreCount obrigatório	Quantos núcleos existem neste conjunto de dimensionamento Exemplo : 16	número inteiro
activeCount necessário	Quantos nós existem neste conjunto de dimensionamento Exemplo : 4	número inteiro
nome necessário	O identificador exclusivo deste grupo de colocação Exemplo : "my-placement-group"	string

virtualMachine

Nome	Descrição	Esquema
gpuCount obrigatório	O número de GPUs que este tipo de máquina tem Exemplo : 2	número inteiro
infiniband necessário	Se esta máquina virtual suportar a conectividade InfiniBand Exemplo : true	boolean
memória obrigatório	A RAM nesta máquina virtual, em GB Exemplo : 7.5	número
pcpuCount obrigatório	O número de CPUs físicas que este tipo de máquina tem Exemplo : 16	número inteiro
vcpuCount necessário	O número de CPUs virtuais que este tipo de máquina tem Exemplo : 32	número inteiro
vcpuQuotaCount opcional	O número de vCPUs que este computador utiliza a partir da quota Exemplo : 2	número inteiro

ClusterUsage

Informações de utilização e custos opcionais para o cluster

Nome	Descrição	Esquema
utilização obrigatório	Uma lista de utilizações por intervalo de tempo Exemplo : [ "object" ]	<utilização> matriz

utilização

Nome	Descrição	Esquema
divisão necessário	A discriminação da utilização neste intervalo, por categoria de "nó" e "nodearray" Exemplo : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> matriz
terminar necessário	O fim do intervalo (exclusivo) Exemplo : "string"	string
iniciar necessário	O início do intervalo (inclusive) Exemplo : "string"	string
total necessário	A utilização geral deste cluster neste intervalo, com uma categoria de "cluster" Exemplo : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Nome	Descrição	Esquema
categoria obrigatório	"cluster" para a utilização geral; "nó" para um único nó de cabeça não matriz; "nodearray" para um nó inteiro Exemplo : "string"	enum (cluster, nó, nóarray)
custo opcional	O montante que seria cobrado por esta utilização, em dólares americanos e a taxas de revenda. Nota: todos os montantes dos custos são estimativas e não refletem a fatura real! Exemplo : 0.0	número
detalhes opcional	Detalhes do tamanho da VM utilizado por um nóarray, incluindo horas, core_count, prioridade da região e sistema operativo. Exemplo : [ "object" ]	<detalhes> matriz
horas necessário	O número de horas principais de utilização para esta categoria Exemplo : 0.0	número
nó opcional	O nome do nó ou nóarray para o que a utilização está (ausente para dados ao nível do cluster) Exemplo : "string"	string

detalhes

Nome	Descrição	Esquema
core_count opcional	O número de núcleos neste tamanho de VM Exemplo : 0.0	número
custo opcional	Custo deste tamanho de VM Exemplo : 0.0	número
horas opcional	O número de horas principais de utilização para este tamanho de VM Exemplo : 0.0	número
so opcional	Tipo de sistema operativo Exemplo : "string"	enum (Windows, Linux)
prioridade opcional	Prioridade do SKU da VM Exemplo : "string"	enum (Regular, Spot)
região opcional	A região em que o tamanho da VM é instanciado Exemplo : "string"	string
vm_size opcional	Tamanho do SKU da VM Exemplo : "string"	string

Nó

Um registo de nó

Tipo : objeto

NodeCreationRequest

Especifica como adicionar nós a um cluster

Nome	Descrição	Esquema
requestId opcional	Token exclusivo fornecido pelo utilizador opcional para evitar operações duplicadas em caso de erros de comunicação de rede. Se estiver incluído e corresponder a um ID de pedido anterior, o servidor ignora este pedido e devolve um erro 409. Exemplo : "00000000-0000-0000-0000-000000000000"	string
conjuntos obrigatório	Uma lista de definições de nós a criar. O pedido tem de conter, pelo menos, um conjunto. Cada conjunto pode especificar um conjunto diferente de propriedades. Exemplo : [ "object" ]	<conjuntos> matriz

conjuntos

Nome	Descrição	Esquema
contagem obrigatório	O número de nós a criar Exemplo : 1	número inteiro
definição opcional	A definição do registo a utilizar. Isto é fornecido pela chamada à API de estado do cluster. Se alguns dos itens indicados na chamada de estado estiverem em falta ou se a propriedade do registo estiver em falta, é utilizado o primeiro registo que corresponde aos itens indicados. Exemplo : "object"	definição
nameFormat opcional	Se for indicado, os nós utilizarão esta convenção de nomenclatura em vez do formato "nodearray-%d" padrão Exemplo : "custom-name-%d"	string
nameOffset opcional	Se for fornecido, juntamente com nameFormat, o desfasa o nodeindex para novos nós. Exemplo : 1	número inteiro
nodeAttributes opcional	Atributos adicionais a definir em cada nó deste conjunto Exemplo : "[node](#node)"	Nó
nodearray obrigatório	O nome da nodearray a partir da origem dos nós Exemplo : "execute"	string
placementGroupId opcional	Se for indicado, os nós com o mesmo valor para groupId serão todos iniciados no mesmo grupo de colocação. Exemplo : "string"	string

definição

Nome	Descrição	Esquema
machineType opcional	Exemplo : "A2"	string

NodeCreationResult

Nome	Descrição	Esquema
operationId necessário	O ID desta operação Exemplo : "00000000-0000-0000-0000-000000000000"	string
conjuntos obrigatório	Uma matriz de conjuntos, pela mesma ordem que no pedido Exemplo : [ "object" ]	<conjuntos> matriz

conjuntos

Nome	Descrição	Esquema
adicionado obrigatório	Quantos nós foram iniciados neste conjunto Exemplo : 1	número inteiro
mensagem opcional	Indica porque é que nem todos os nós pedidos podem ser adicionados, se estiverem presentes Exemplo : "string"	string

NodeList

Resultados de uma pesquisa de nós

Nome	Descrição	Esquema
nós obrigatório	Os nós devolvidos Exemplo : [ "[node](#node)" ]	<> Nó matriz
operação opcional	Se a consulta incluir um ID de operação, este é o estado dessa operação Exemplo : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Especifica como executar ações em nós num cluster. Existem várias formas de especificar nós e, se for incluída mais do que uma forma, é tratada como uma união.

Nome	Descrição	Esquema
filtrar opcional	Uma expressão de filtro que corresponde aos nós. Tenha em atenção que as cadeias na expressão têm de ser citadas corretamente. Exemplo : "State === \"Started\""	string
nomes de anfitrião opcional	Uma lista de nomes de anfitrião curtos (sem domínio) para gerir Exemplo : [ "hostname1", "hostname2" ]	<matriz de cadeias de carateres >
IDs opcional	Uma lista de IDs de nós a gerir Exemplo : [ "id1", "id2" ]	<matriz de cadeia >
ip_addresses opcional	Uma lista de endereços IP a gerir Exemplo : [ "10.0.1.1", "10.1.1.2" ]	<matriz de cadeia >
nomes opcional	Uma lista de nomes de nós a gerir Exemplo : [ "name1", "name2" ]	<matriz de cadeia >
requestId opcional	Token exclusivo fornecido pelo utilizador opcional para evitar operações duplicadas em caso de erros de comunicação de rede. Se estiver incluído e corresponder a um ID de pedido anterior, o servidor ignora este pedido e devolve um erro 409. Exemplo : "00000000-0000-0000-0000-000000000000"	string

NodeManagementResult

Nome	Descrição	Esquema
nós obrigatório	Uma matriz de informações sobre cada nó que corresponde ao filtro no pedido de gestão. O estado de cada nó indica se foi afetado pelo pedido. Exemplo : [ "object" ]	<> nós matriz
operationId necessário	O ID desta operação Exemplo : "00000000-0000-0000-0000-000000000000"	string

nós

Nome	Descrição	Esquema
erro opcional	Se o estado for Erro, isto contém a mensagem de erro Exemplo : "This node must be terminated before it can be removed"	string
id necessário	O ID do nó Exemplo : "id1"	string
nome necessário	O nome do nó Exemplo : "name1"	string
estado opcional	Um de OK ou Erro Exemplo : "Error"	enum (OK, Erro)

OperationStatus

O estado desta operação de nó

Nome	Descrição	Esquema
ação obrigatório	Exemplo : "string"	enum (criar)
startTime necessário	Quando esta operação foi submetida Exemplo : "2020-01-01T12:34:56Z"	cadeia (data-hora)