Operações
Obter nós de cluster
GET /clusters/{cluster}/nodes
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster a ser consultado | string |
| de consulta |
operação opcional |
Se fornecido, retorna apenas os nós para essa id de operação e inclui o atributo operation no corpo | string |
| de consulta |
request_id opcional |
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 |
string |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 200 | OK | NodeList |
| 400 | Especificação inválida | Sem conteúdo |
| 404 | Não encontrado | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes
Exemplo de resposta HTTP
Resposta 200
{
"nodes" : [ { } ],
"operation" : {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
}
Criar nós de cluster
POST /clusters/{cluster}/nodes/create
Descrição
Esta 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 pode ser usada para controlar o status da operação.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster ao qual adicionar nós | string |
| Corpo |
nós necessário |
Conjuntos de nós a serem criados | NodeCreationRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeCreationResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/create
Corpo do pedido
{
"requestId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
Exemplo de resposta HTTP
Resposta 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
Desalocar nós de cluster
POST /clusters/{cluster}/nodes/deallocate
Descrição
Esta operação deslocaliza nós em um cluster. Os nós podem ser identificados de várias maneiras, incluindo nome do nó, id do nó ou por filtro.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para desalocar nós em | string |
| Corpo |
ação necessário |
Descrição de quais nós devem ser desalocados | NodeManagementRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeManagementResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/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"
}
Exemplo de resposta HTTP
Resposta 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
Encerrar e remover nós de cluster
POST /clusters/{cluster}/nodes/remove
Descrição
Esta operação remove nós em um cluster. Os nós podem ser identificados de várias maneiras, incluindo nome do nó, id do nó ou por filtro. Observe que, por padrão, os nós são removidos quando terminados (a menos que o nó tenha Fixed definido como true), caso em que essa chamada não é diferente de terminate.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para remover nós em | string |
| Corpo |
ação necessário |
Descrição de quais nós remover | NodeManagementRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeManagementResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/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"
}
Exemplo de resposta HTTP
Resposta 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
Encerrar ou desalocar nós de cluster
POST /clusters/{cluster}/nodes/shutdown
Descrição
Essa operação encerra ou desaloca nós em um cluster, dependendo se o atributo ShutdownPolicy em cada nó é Terminate (o padrão) ou Deallocate, respectivamente.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para desligar nós em | string |
| Corpo |
ação necessário |
Descrição de quais nós devem ser desligados | NodeManagementRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeManagementResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/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"
}
Exemplo de resposta HTTP
Resposta 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
Iniciar nós de cluster desalocados ou encerrados
POST /clusters/{cluster}/nodes/start
Descrição
Esta operação inicia nós em um cluster. Os nós podem ser identificados de várias maneiras, incluindo nome do nó, id do nó ou por filtro.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para iniciar nós em | string |
| Corpo |
ação necessário |
Descrição de quais nós iniciar | NodeManagementRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeManagementResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/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"
}
Exemplo de resposta HTTP
Resposta 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
Encerrar nós de cluster
POST /clusters/{cluster}/nodes/terminate
Descrição
Esta operação encerra nós em um cluster. Os nós podem ser identificados de várias maneiras, incluindo nome do nó, id do nó ou por filtro.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para encerrar nós em | string |
| Corpo |
ação necessário |
Descrição de quais nós devem ser encerrados | NodeManagementRequest |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeManagementResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/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"
}
Exemplo de resposta HTTP
Resposta 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
Dimensionar o cluster de acordo com o tamanho
POST /clusters/{cluster}/scale/{nodearray}
Descrição
Esta operação adiciona nós, conforme necessário, a uma matriz de nós para atingir uma contagem total. A solicitação é processada uma vez e não adiciona nós novamente posteriormente para manter o número determinado. Isso é dimensionado por núcleos totais ou nós totais, mas não ambos. Ele retorna a URL para a operação que pode ser usada para controlar o status da operação.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster ao qual adicionar nós | string |
| Caminho |
nodearray necessário |
O nodearray ao qual adicionar nós | string |
| de consulta |
totalCoreCount opcional |
O número total de núcleos a ter nesta matriz de nós, incluindo nós já criados | inteiro |
| de consulta |
totalNodeCount opcional |
O número total de máquinas a ter nesta matriz de nós, incluindo nós já criados | inteiro |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 202 | Aceito Cabeçalhos : Location (string) : O URL da operação. |
NodeCreationResult |
| 409 | Entrada inválida | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME
Exemplo de resposta HTTP
Resposta 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
Obter o status do cluster
GET /clusters/{cluster}/status
Descrição
Esta operação contém informações para os nós e matrizes de nós em um determinado cluster. Para cada nodearray, ele retorna o status de cada "bucket" de alocação que pode ser usado, como quantos nós estão no bucket, quantos mais podem ser adicionados, etc. Cada bucket é um conjunto de possíveis VMs de um determinado perfil de hardware, que podem ser criadas em um determinado local, sob uma determinada conta de cliente, etc. Os buckets válidos para uma matriz de nó são determinados pela definição de cluster do usuário, mas os limites são determinados em parte pelo provedor de nuvem.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster a ser consultado | string |
| de consulta |
nós opcional |
Se verdadeiro, nós e referências de nó são retornados na resposta | Booleano |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 200 | OK | ClusterStatus |
Exemplo de solicitação HTTP
Caminho da solicitação
/clusters/CLUSTER_NAME/status
Exemplo de resposta HTTP
Resposta 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
Descrição
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.
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
cluster necessário |
O cluster para retornar dados de uso para | string |
| de consulta |
prazo opcional |
Se fornecido, isso especifica o intervalo de tempo a ser usado 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. Todos os horários estão em UTC. | enum (monthToDate, lastMonth, weekToDate, personalizado) |
| de consulta |
, opcional |
Para períodos de tempo personalizados, este é o início do período no formato ISO-8601. Este valor é arredondado por defeito para a hora ou dia mais próximo. | string |
| de consulta |
para opcional |
Para períodos de tempo personalizados, este é o fim do período no formato ISO-8601. Este valor é arredondado para a hora ou dia mais próximo. | string |
| de consulta |
granularidade opcional |
Especifica como agregar dados: por hora, por dia ou como um único número. Esse padrão é diário. | Enum (total, diário, horário) |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 200 | OK | ClusterUsage |
Exemplo de solicitação HTTP
Caminho da solicitação
/clusters/CLUSTER_NAME/usage
Exemplo de resposta HTTP
Resposta 200
{
"usage" : [ "object" ]
}
Lista o status das operações
GET /operations/
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| de consulta |
request_id opcional |
O ID da solicitação para a operação. Se isso for dado, a lista terá apenas 0 ou 1 elemento nela. | string |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 200 | OK | < matriz de> OperationStatus |
| 400 | Pedido inválido | Sem conteúdo |
| 404 | Não encontrado | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/operations/
Exemplo de resposta HTTP
Resposta 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
Obtém o status da operação por id
GET /operations/{id}
Parâmetros
| Tipo | Designação | Descrição | Esquema |
|---|---|---|---|
| Caminho |
id necessário |
O ID da operação | string |
Respostas
| Código HTTP | Descrição | Esquema |
|---|---|---|
| 200 | OK | OperationStatus |
| 404 | Não encontrado | Sem conteúdo |
Exemplo de solicitação HTTP
Caminho da solicitação
/operations/00000000-0000-0000-0000-000000000000
Exemplo de resposta HTTP
Resposta 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
Recursos
Status do cluster
Status do cluster
| Designação | Descrição | Esquema |
|---|---|---|
|
maxCoreCount necessário |
O número máximo de núcleos que podem ser adicionados a este cluster Exemplo : 16 |
inteiro |
|
maxCount necessário |
O número máximo de nós que podem ser adicionados a este cluster Exemplo : 4 |
inteiro |
|
nodearrays necessário |
Exemplo : [ "object" ] |
< nodearrays> array |
|
nós opcional |
Uma lista opcional de nós neste cluster, incluída apenas se nodes=true estiver na consulta Exemplo : [ "[node](#node)" ] |
< Matriz de> de nós |
|
estado opcional |
O estado atual do cluster, se ele tiver sido iniciado pelo menos uma vez Exemplo : "Starting" |
string |
|
targetState opcional |
O estado desejado do cluster (por exemplo, Iniciado ou Encerrado) Exemplo : "Started" |
string |
| Designação | Descrição | Esquema |
|---|---|---|
|
baldes necessário |
Cada bucket de alocação para este nodearray. As configurações de "contagem de núcleos" são sempre um múltiplo da contagem de núcleos para esse bucket. Exemplo : [ "object" ] |
< buckets> array |
|
maxCoreCount necessário |
O número máximo de núcleos que podem estar neste nodearray Exemplo : 16 |
inteiro |
|
maxCount necessário |
O número máximo de nós que podem estar nessa matriz de nós Exemplo : 4 |
inteiro |
|
nome necessário |
O nodearray que está descrevendo Exemplo : "execute" |
string |
|
nodearray necessário |
Os atributos desta matriz de nós Exemplo : "[node](#node)" |
Nó |
| Designação | Descrição | Esquema |
|---|---|---|
|
activeCoreCount necessário |
O número de núcleos em uso para este bucket, neste nodearray Exemplo : 40 |
inteiro |
|
activeCount necessário |
O número de nós em uso para este bucket, nesta nodearray. Isso inclui nós que ainda estão adquirindo uma VM. Exemplo : 10 |
inteiro |
|
activeNodes opcional |
Os nomes de nó em uso para este bucket, nesta nodearray. Isso inclui nós que ainda estão adquirindo uma VM. Isso só será incluído se nodes=true estiver na consulta. Exemplo : [ "string" ] |
< cadeia de caracteres > matriz |
|
disponívelCoreCount necessário |
Quantos núcleos extras podem ser criados neste bucket, neste nodearray. Sempre um múltiplo de availableCount. Exemplo : 8 |
inteiro |
|
disponíveisConte necessário |
Quantos nós extras podem ser criados neste bucket, neste nodearray. Observe que isso pode ser menor do que o implícito por maxCount e usedCount, uma vez que maxCount pode ser limitado globalmente. Exemplo : 2 |
inteiro |
|
bucketId necessário |
O identificador para este bucket. Isso sempre terá o mesmo valor para um determinado bucket em uma matriz de nó, desde que o cluster não seja excluído. Exemplo : "00000000-0000-0000-0000-000000000000" |
string |
|
consumido CoreCount necessário |
O número de núcleos para esta família que já estão em uso em toda a região. Exemplo : 2 |
inteiro |
|
definição opcional |
As propriedades desse bucket, usadas para criar nós a partir desse bucket. A API create-nodes usa essa definição em sua propriedade bucket. Exemplo : "object" |
definição |
|
famíliaConsumedCoreCount opcional |
O número de núcleos para esta família que já estão em uso em toda a região. Exemplo : 2 |
inteiro |
|
famíliaQuotaCoreCount 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 múltiplo inteiro de quotaCount. Exemplo : 16 |
inteiro |
|
famíliaQuotaCount opcional |
O número total de instâncias que podem ser iniciadas (dado familyQuotaCoreCount) Exemplo : 4 |
inteiro |
|
invalidReason necessário |
Se valid for false, isso conterá o motivo pelo qual o bucket é inválido. Atualmente, NotActivated e DisabledMachineType são os únicos motivos. Exemplo : "DisabledMachineType" |
string |
|
lastCapacityFailure necessário |
Quanto tempo, em segundos, desde a última vez que este bucket 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 nesse bucket, incluindo limites globais e nodearray. Sempre um múltiplo de maxCount. Exemplo : 16 |
inteiro |
|
maxCount necessário |
O número máximo de nós que podem estar nesse bucket, incluindo limites globais e nodearray Exemplo : 4 |
inteiro |
|
maxPlacementGroupCoreSize necessário |
O número total máximo de núcleos que podem estar em um grupo de posicionamento neste bucket. Sempre um múltiplo de maxPlacementGroupSize. Exemplo : 64 |
inteiro |
|
maxPlacementGroupSize necessário |
O número total máximo de instâncias que podem estar em um grupo de posicionamento neste bucket Exemplo : 16 |
inteiro |
|
placementGrupos necessário |
Os grupos de posicionamento em uso para essa matriz de nós, se houver. Exemplo : [ "object" ] |
< placementGroups> array |
|
quotaCoreCount necessário |
O número de núcleos totais que podem ser iniciados para esta família nesta região, tendo em conta também a contagem do núcleo de quota regional. Este pode não ser um múltiplo inteiro de quotaCount. Exemplo : 16 |
inteiro |
|
quotaCount necessário |
O número total de instâncias que podem ser iniciadas (dada quotaCoreCount) Exemplo : 4 |
inteiro |
|
regionalConsumedCoreCount opcional |
O número de núcleos que já estão em uso em toda a região. Exemplo : 2 |
inteiro |
|
regionalQuotaCoreCount opcional |
O número total de núcleos que podem ser iniciados nesta região. Este pode não ser um múltiplo inteiro de regionalQuotaCount. Exemplo : 16 |
inteiro |
|
regionalQuotaCount opcional |
O número total de instâncias que podem ser iniciadas (dado regionalQuotaCoreCount) Exemplo : 4 |
inteiro |
|
válido necessário |
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. Exemplo : true |
Booleano |
|
virtualMachine necessário |
As propriedades das máquinas virtuais iniciadas a partir desse bucket Exemplo : "object" |
virtualMachine |
| Designação | Descrição | Esquema |
|---|---|---|
|
máquinaTipo necessário |
O tamanho da VM da máquina virtual Exemplo : "A2" |
string |
| Designação | Descrição | Esquema |
|---|---|---|
|
activeCoreCount necessário |
Quantos núcleos existem neste conjunto de escalas Exemplo : 16 |
inteiro |
|
activeCount necessário |
Quantos nós estão neste conjunto de escalas Exemplo : 4 |
inteiro |
|
nome necessário |
O identificador exclusivo deste grupo de posicionamento Exemplo : "my-placement-group" |
string |
| Designação | Descrição | Esquema |
|---|---|---|
|
gpuCount necessário |
O número de GPUs que este tipo de máquina tem Exemplo : 2 |
inteiro |
|
infiniband necessário |
Se esta máquina virtual suportar conectividade InfiniBand Exemplo : true |
Booleano |
|
memória necessário |
A RAM nesta máquina virtual, em GB Exemplo : 7.5 |
número |
|
pcpuCount necessário |
O número de CPUs físicas que este tipo de máquina tem Exemplo : 16 |
inteiro |
|
vcpuCount necessário |
O número de CPUs virtuais que este tipo de máquina tem Exemplo : 32 |
inteiro |
|
vcpuQuotaCount opcional |
O número de vCPUs que esta máquina usa da cota Exemplo : 2 |
inteiro |
ClusterUsage
Informações de uso e custo opcionais para o cluster
| Designação | Descrição | Esquema |
|---|---|---|
|
uso necessário |
Uma lista de usos por intervalo de tempo Exemplo : [ "object" ] |
< uso> array |
| Designação | Descrição | Esquema |
|---|---|---|
|
desagregação necessário |
A divisão do uso neste intervalo, por categoria de "nó" e "nodearray" Exemplo : [ "[clusterusageitem](#clusterusageitem)" ] |
< matriz de> ClusterUsageItem |
|
fim necessário |
O fim do intervalo (exclusivo) Exemplo : "string" |
string |
|
começar necessário |
O início do intervalo (inclusive) Exemplo : "string" |
string |
|
total necessário |
O uso geral para este cluster neste intervalo, com uma categoria de "cluster" Exemplo : "[clusterusageitem](#clusterusageitem)" |
ClusterUsageItem |
ClusterUsageItem
| Designação | Descrição | Esquema |
|---|---|---|
|
categoria necessário |
"cluster" para o uso geral; "nó" para um único nó principal que não seja de matriz; "nodearray" para um nodearray inteiro Exemplo : "string" |
enum (cluster, nó, nodearray) |
|
custo opcional |
O valor que seria cobrado por esse uso, em dólares americanos e a taxas de varejo. Nota: todos os valores de custos são estimativas e não refletem a fatura real! Exemplo : 0.0 |
número |
|
detalhes opcional |
Detalhes do tamanho da VM usada por um nodearray, incluindo horas, core_count, prioridade da região e sistema operacional. Exemplo : [ "object" ] |
< detalhes> matriz |
|
horas necessário |
O número de horas-núcleo de uso para esta categoria Exemplo : 0.0 |
número |
|
nó opcional |
O nome do nó ou nodearray para o qual o uso é (ausente para dados no nível de cluster) Exemplo : "string" |
string |
| Designação | 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 uso para esse tamanho de VM Exemplo : 0.0 |
número |
|
os opcional |
Tipo de sistema operativo Exemplo : "string" |
enum (Windows, Linux) |
|
prioridade opcional |
Prioridade da VM Sku 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 VM Sku Exemplo : "string" |
string |
Nó
Um registro de nó
Tipo : objeto
NodeCreationRequest
Especifica como adicionar nós a um cluster
| Designação | Descrição | Esquema |
|---|---|---|
|
requestId opcional |
Token exclusivo opcional fornecido pelo usuário para evitar operações duplicadas em caso de erros de comunicação de rede. Se isso estiver incluído e corresponder a uma ID de solicitação anterior, o servidor ignorará essa solicitação e retornará um erro 409. Exemplo : "00000000-0000-0000-0000-000000000000" |
string |
|
conjuntos necessário |
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. Exemplo : [ "object" ] |
< conjuntos> matriz |
| Designação | Descrição | Esquema |
|---|---|---|
|
contagem necessário |
O número de nós a serem criados Exemplo : 1 |
inteiro |
|
definição opcional |
A definição do bucket a ser usado. Isso é fornecido pela chamada da API de status do cluster. Se alguns dos itens fornecidos na chamada de status estiverem faltando ou a propriedade bucket inteira estiver faltando, o primeiro bucket que corresponder aos itens fornecidos será usado. Exemplo : "object" |
definição |
|
nameFormat opcional |
Se fornecida, os nós usarão essa convenção de nomenclatura em vez do formato padrão "nodearray-%d" Exemplo : "custom-name-%d" |
string |
|
nomeOffset opcional |
Se fornecido, juntamente com nameFormat, desloca nodeindex para novos nós. Exemplo : 1 |
inteiro |
|
nodeAttributes opcional |
Atributos adicionais a serem definidos em cada nó desse conjunto Exemplo : "[node](#node)" |
Nó |
|
nodearray necessário |
O nome da matriz de nós a partir da qual iniciar nós Exemplo : "execute" |
string |
|
placementGroupId opcional |
Se fornecido, os nós com o mesmo valor para groupId serão todos iniciados no mesmo grupo de posicionamento. Exemplo : "string" |
string |
| Designação | Descrição | Esquema |
|---|---|---|
|
máquinaTipo opcional |
Exemplo : "A2" |
string |
NodeCreationResult
| Designação | Descrição | Esquema |
|---|---|---|
|
operationId necessário |
O id desta operação Exemplo : "00000000-0000-0000-0000-000000000000" |
string |
|
conjuntos necessário |
Uma matriz de conjuntos, na mesma ordem da solicitação Exemplo : [ "object" ] |
< conjuntos> matriz |
| Designação | Descrição | Esquema |
|---|---|---|
|
adicionado necessário |
Quantos nós foram iniciados neste conjunto Exemplo : 1 |
inteiro |
|
mensagem opcional |
Indica por que nem todos os nós solicitados podem ser adicionados, se presentes Exemplo : "string" |
string |
Lista de Nós
Resultados de uma pesquisa de nó
| Designação | Descrição | Esquema |
|---|---|---|
|
nós necessário |
Os nós retornados Exemplo : [ "[node](#node)" ] |
< Matriz de> de nós |
|
operação opcional |
Se a consulta incluir uma ID de operação, este é o status dessa operação Exemplo : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
Especifica como executar ações em nós em um cluster. Há várias maneiras de especificar nós e, se mais de uma maneira for incluída, ela será tratada como uma união.
| Designação | Descrição | Esquema |
|---|---|---|
|
filtrar opcional |
Uma expressão de filtro que corresponde a nós. Observe que as cadeias de caracteres na expressão devem ser citadas corretamente. Exemplo : "State === \"Started\"" |
string |
|
nomes de host opcional |
Uma lista de nomes de host curtos (sem domínio) para gerenciar Exemplo : [ "hostname1", "hostname2" ] |
< cadeia de caracteres > matriz |
|
ids opcional |
Uma lista de ids de nó para gerenciar Exemplo : [ "id1", "id2" ] |
< cadeia de caracteres > matriz |
|
ip_addresses opcional |
Uma lista de endereços IP para gerenciar Exemplo : [ "10.0.1.1", "10.1.1.2" ] |
< cadeia de caracteres > matriz |
|
nomes opcional |
Uma lista de nomes de nós para gerenciar Exemplo : [ "name1", "name2" ] |
< cadeia de caracteres > matriz |
|
requestId opcional |
Token exclusivo opcional fornecido pelo usuário para evitar operações duplicadas em caso de erros de comunicação de rede. Se isso estiver incluído e corresponder a uma ID de solicitação anterior, o servidor ignorará essa solicitação e retornará um erro 409. Exemplo : "00000000-0000-0000-0000-000000000000" |
string |
NodeManagementResult
| Designação | Descrição | Esquema |
|---|---|---|
|
nós necessário |
Uma matriz de informações sobre cada nó que correspondia ao filtro na solicitação de gerenciamento. O status de cada nó indica se ele foi afetado pela solicitação. Exemplo : [ "object" ] |
< nós> matriz |
|
operationId necessário |
O id desta operação Exemplo : "00000000-0000-0000-0000-000000000000" |
string |
| Designação | Descrição | Esquema |
|---|---|---|
|
erro opcional |
Se o status for Erro, ele conterá 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 |
|
status opcional |
Um de OK ou Erro Exemplo : "Error" |
enum (OK, Erro) |
Status da operação
O status desta operação de nó
| Designação | Descrição | Esquema |
|---|---|---|
|
ação necessário |
Exemplo : "string" |
enum (criar) |
|
startTime necessário |
Quando esta operação foi submetida Exemplo : "2020-01-01T12:34:56Z" |
string (data-hora) |