Operações
Obter nós de cluster
GET /clusters/{cluster}/nodes
Parâmetros
Tipo | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster a ser consultado | corda |
de consulta | de operação opcional |
Se dado, retorna apenas os nós para esta ID de operação e inclui o atributo de operação no corpo | corda |
de consulta |
request_id opcional |
Se for dado, retornará apenas os nós para a operação identificada por essa ID de solicitação, e inclui o atributo de operação no corpo |
corda |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
200 | OKEY | NodeList |
400 | Especificação inválida | Sem conteúdo |
404 | Não encontrado | Sem conteúdo |
Solicitação HTTP de exemplo
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
Essa operação adiciona novos nós de um nodearray 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 acompanhar o status da operação.
Parâmetros
Tipo | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster ao qual adicionar nós | corda |
body |
nós necessária |
Conjuntos de nós a serem criados | NodeCreationRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeCreationResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/create
Corpo da solicitação
{
"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 desaloca 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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para desalocar nós em | corda |
body | de ação necessária |
Descrição de quais nós desalocar | NodeManagementRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeManagementResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/deallocate
Corpo da solicitação
{
"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
Essa 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 encerrados (a menos que o nó tenha corrigido definido como true), nesse caso, essa chamada não é diferente de terminar.
Parâmetros
Tipo | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para remover nós em | corda |
body | de ação necessária |
Descrição de quais nós remover | NodeManagementRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeManagementResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/remove
Corpo da solicitação
{
"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 termina ou desaloca nós em um cluster, dependendo se o atributo ShutdownPolicy em cada nó é Terminate (o padrão) ou Desalocado, respectivamente.
Parâmetros
Tipo | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para desligar nós em | corda |
body | de ação necessária |
Descrição dos nós a serem desligados | NodeManagementRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeManagementResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/shutdown
Corpo da solicitação
{
"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
Essa 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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para iniciar nós em | corda |
body | de ação necessária |
Descrição de quais nós iniciar | NodeManagementRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeManagementResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/start
Corpo da solicitação
{
"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
Essa 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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para encerrar nós em | corda |
body | de ação necessária |
Descrição de quais nós serão encerrados | NodeManagementRequest |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeManagementResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
Caminho da solicitação
/clusters/CLUSTER_NAME/nodes/terminate
Corpo da solicitação
{
"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 cluster para tamanho
POST /clusters/{cluster}/scale/{nodearray}
Descrição
Essa operação adiciona nós conforme necessário a um nodearray para atingir uma contagem total. A solicitação é processada uma vez e não adiciona novamente nós mais tarde para manter o número especificado. 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 acompanhar o status da operação.
Parâmetros
Tipo | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster ao qual adicionar nós | corda |
de caminho |
de nodearray necessária |
O nodearray ao qual adicionar nós | corda |
de consulta |
totalCoreCount opcional |
O número total de núcleos a serem incluídos nesse nodearray, incluindo nós já criados | inteiro |
de consulta |
totalNodeCount opcional |
O número total de computadores a serem incluídos nesse nodearray, incluindo nós já criados | inteiro |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
202 | Aceitado cabeçalhos : Location (cadeia de caracteres) : a URL da operação. |
NodeCreationResult |
409 | Entrada inválida | Sem conteúdo |
Solicitação HTTP de exemplo
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 as nodearrays 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 VMs possíveis de um determinado perfil de hardware, que podem ser criadas em um determinado local, em uma determinada conta de cliente, etc. Os buckets válidos para uma nodearray 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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster a ser consultado | corda |
de consulta |
nós opcional |
Se for true, nós e referências de nó serão retornados na resposta | booleano |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
200 | OKEY | |
Solicitação HTTP de exemplo
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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
cluster necessária |
O cluster para o qual retornar dados de uso | corda |
de consulta |
de período 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 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 em UTC. | enum (monthToDate, lastMonth, weekToDate, custom) |
de consulta |
de opcional |
Para quadros de tempo personalizados, este é o início do período no formato ISO-8601. Isso é arredondado para a hora ou o dia mais próximo. | corda |
de consulta |
opcional |
Para quadros de tempo personalizados, esse é o fim do período no formato ISO-8601. Isso é arredondado para a hora ou o dia mais próximo. | corda |
de consulta |
de granularidade opcional |
Especifica como agregar dados: por hora, por dia ou como um único número. Esse padrão é diário. | enumeração (total, diariamente, por hora) |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
200 | OKEY | clusterUsage |
Solicitação HTTP de exemplo
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 | Nome | Descrição | Esquema |
---|---|---|---|
de consulta |
request_id opcional |
A ID da solicitação da operação. Se isso for fornecido, a lista terá apenas 0 ou 1 elemento. | corda |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
200 | OKEY | < matriz de> OperationStatus |
400 | Solicitação inválida | Sem conteúdo |
404 | Não encontrado | Sem conteúdo |
Solicitação HTTP de exemplo
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 | Nome | Descrição | Esquema |
---|---|---|---|
de caminho |
de ID necessária |
A ID da operação | corda |
Respostas
Código HTTP | Descrição | Esquema |
---|---|---|
200 | OKEY | |
404 | Não encontrado | Sem conteúdo |
Solicitação HTTP de exemplo
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
ClusterStatus
Status do cluster
Nome | Descrição | Esquema |
---|---|---|
maxCoreCount necessária |
O número máximo de núcleos que podem ser adicionados a esse cluster de exemplo |
inteiro |
maxCount necessária |
O número máximo de nós que podem ser adicionados a esse cluster de exemplo |
inteiro |
nodearrays necessária |
de exemplo |
< matriz de> de nodearrays |
nós opcional |
Uma lista opcional de nós neste cluster, incluída somente se nós=true estiver na consulta de exemplo |
matriz |
de estado opcional |
O estado atual do cluster, se ele tiver sido iniciado pelo menos uma vez de exemplo |
corda |
targetState opcional |
O estado desejado do cluster (por exemplo, Iniciado ou Encerrado) de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
buckets necessária |
Cada bucket de alocação para esse nodearray. As configurações de "contagem de núcleos" são sempre um múltiplo da contagem de núcleos para esse bucket. de exemplo |
< buckets> matriz |
maxCoreCount necessária |
O número máximo de núcleos que podem estar neste nodearray de exemplo |
inteiro |
maxCount necessária |
O número máximo de nós que podem estar neste nodearray de exemplo |
inteiro |
nome necessária |
O nodearray que está descrevendo de exemplo |
corda |
de nodearray necessária |
Os atributos dessa nodearray de exemplo |
Node |
Nome | Descrição | Esquema |
---|---|---|
activeCoreCount necessária |
O número de núcleos em uso para este bucket, neste nodearray de exemplo |
inteiro |
activeCount necessária |
O número de nós em uso para este bucket, neste nodearray. Isso inclui nós que ainda estão adquirindo uma VM. de exemplo |
inteiro |
activeNodes opcional |
Os nomes de nó em uso para este bucket, neste nodearray. Isso inclui nós que ainda estão adquirindo uma VM. Isso só será incluído se nós=true estiverem na consulta. de exemplo |
< matriz de > de cadeia de caracteres |
deCoreCount disponíveis necessária |
Quantos núcleos extras podem ser criados neste bucket, neste nodearray. Sempre um múltiplo de Count disponível. de exemplo |
inteiro |
availableCount necessária |
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, já que maxCount pode ser limitado globalmente. de exemplo |
inteiro |
bucketId necessária |
O identificador deste bucket. Isso sempre terá o mesmo valor para um determinado bucket em um nodearray, desde que o cluster não seja excluído. de exemplo |
corda |
consumedCoreCount necessária |
O número de núcleos dessa família que já estão em uso em toda a região. de exemplo |
inteiro |
de definição de opcional |
As propriedades desse bucket, usadas para criar nós desse bucket. A API create-nodes usa essa definição em sua propriedade bucket . de exemplo |
de definição de |
familyConsumedCoreCount opcional |
O número de núcleos dessa família que já estão em uso em toda a região. de exemplo |
inteiro |
familyQuotaCoreCount opcional |
O número de núcleos totais que podem ser iniciados para essa família nessa região. Isso pode não ser um múltiplo inteiro de quotaCount. de exemplo |
inteiro |
familyQuotaCount opcional |
O número total de instâncias que podem ser iniciadas (dado familyQuotaCoreCount) de exemplo |
inteiro |
invalidReason necessária |
Se válido for falso, isso conterá o motivo pelo qual o bucket é inválido. Atualmente, NotActivated e DisabledMachineType são os únicos motivos. de exemplo |
corda |
lastCapacityFailure necessária |
Quanto tempo, em segundos, desde a última vez em que esse bucket sofreu uma falha de capacidade. Qualquer valor negativo é tratado como nunca. de exemplo |
número |
maxCoreCount necessária |
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. de exemplo |
inteiro |
maxCount necessária |
O número máximo de nós que podem estar neste bucket, incluindo limites globais e de nodearray de exemplo |
inteiro |
maxPlacementGroupCoreSize necessária |
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. de exemplo |
inteiro |
maxPlacementGroupSize necessária |
O número total máximo de instâncias que podem estar em um grupo de posicionamento neste bucket de exemplo |
inteiro |
placementGroups necessária |
Os grupos de posicionamento em uso para este nodearray, se houver. de exemplo |
< placementGroups> matriz |
quotaCoreCount necessária |
O número de núcleos totais que podem ser iniciados para essa família nessa região, levando em conta também a contagem de núcleos de cota regional. Isso pode não ser um múltiplo inteiro de quotaCount. de exemplo |
inteiro |
quotaCount necessária |
O número total de instâncias que podem ser iniciadas (dado quotaCoreCount) de exemplo |
inteiro |
regionalConsumedCoreCount opcional |
O número de núcleos que já estão em uso em toda a região. de exemplo |
inteiro |
regionalQuotaCoreCount opcional |
O número de núcleos totais que podem ser iniciados nessa região. Isso pode não ser um múltiplo inteiro de regionalQuotaCount. de exemplo |
inteiro |
regionalQuotaCount opcional |
O número total de instâncias que podem ser iniciadas (dado regionalQuotaCoreCount) de exemplo |
inteiro |
válido necessária |
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. de exemplo |
booleano |
virtualMachine necessária |
As propriedades das máquinas virtuais iniciadas a partir deste bucket de exemplo |
virtualMachine |
Nome | Descrição | Esquema |
---|---|---|
machineType necessária |
O tamanho da VM da máquina virtual de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
activeCoreCount necessária |
Quantos núcleos estão neste conjunto de dimensionamento de exemplo |
inteiro |
activeCount necessária |
Quantos nós estão neste conjunto de dimensionamento de exemplo |
inteiro |
nome necessária |
O identificador exclusivo desse grupo de posicionamento de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
gpuCount necessária |
O número de GPUs que esse tipo de computador tem de exemplo |
inteiro |
infiniband necessária |
Se essa máquina virtual der suporte à conectividade infiniBand de exemplo |
booleano |
memória necessária |
A RAM nesta máquina virtual, em GB de exemplo |
número |
pcpuCount necessária |
O número de CPUs físicas que esse tipo de computador tem de exemplo |
inteiro |
vcpuCount necessária |
O número de CPUs virtuais que esse tipo de computador tem de exemplo |
inteiro |
vcpuQuotaCount opcional |
O número de vCPUs que este computador usa da cota de exemplo |
inteiro |
ClusterUsage
Informações de uso e custo opcional para o cluster
Nome | Descrição | Esquema |
---|---|---|
de uso necessária |
Uma lista de usos por intervalo de tempo de exemplo |
matriz de |
Nome | Descrição | Esquema |
---|---|---|
de detalhamento necessária |
A divisão do uso neste intervalo, por categoria de "nó" e "nodearray" de exemplo |
< matriz> ClusterUsageItem |
final necessária |
O final do intervalo (exclusivo) de exemplo |
corda |
iniciar necessária |
O início do intervalo (inclusivo) de exemplo |
corda |
total de necessária |
O uso geral desse cluster neste intervalo, com uma categoria de "cluster" de exemplo |
|
ClusterUsageItem
Nome | Descrição | Esquema |
---|---|---|
de categoria necessária |
"cluster" para o uso geral; "nó" para um único nó de cabeçalho não matriz; "nodearray" para uma nodearray inteira de exemplo |
enum (cluster, nó, nodearray) |
custo opcional |
O valor que seria 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! de exemplo |
número |
detalhes opcional |
Detalhes do tamanho da VM usado por uma nodearray, incluindo horas, core_count, prioridade da região e sistema operacional. de exemplo |
< detalhes> matriz |
horas necessária |
O número de horas principais de uso para essa categoria de exemplo |
número |
nó opcional |
O nome do nó ou nodearray para o qual o uso é (ausente para dados no nível do cluster) de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
core_count opcional |
O número de núcleos nesse tamanho de VM de exemplo |
número |
custo opcional |
Custo desse tamanho de VM de exemplo |
número |
horas opcional |
O número de horas principais de uso para esse tamanho de VM de exemplo |
número |
sistema operacional opcional |
Tipo de sistema operacional de exemplo |
enum (Windows, Linux) |
de prioridade opcional |
Prioridade do SKU da VM de exemplo |
enum (Regular, Spot) |
região opcional |
A região em que o tamanho da VM é instanciado de exemplo |
corda |
vm_size opcional |
Tamanho do SKU da VM de exemplo |
corda |
Nodo
Um registro de nó
Tipo: objeto
NodeCreationRequest
Especifica como adicionar nós a um cluster
Nome | Descrição | Esquema |
---|---|---|
requestId opcional |
Token exclusivo fornecido pelo usuário opcional para impedir operações duplicadas em caso de erros de comunicação de rede. Se isso for incluído e corresponder a uma ID de solicitação anterior, o servidor ignorará essa solicitação e retornará um erro 409. de exemplo |
corda |
define necessária |
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. de exemplo |
< define> matriz |
Nome | Descrição | Esquema |
---|---|---|
contagem necessária |
O número de nós a serem criados de exemplo |
inteiro |
de definição de opcional |
A definição do bucket a ser usado. Isso é fornecido pela chamada à API de status do cluster. Se alguns dos itens fornecidos na chamada de status estiverem ausentes ou a propriedade inteira do bucket estiver ausente, o primeiro bucket que corresponde aos itens fornecidos será usado. de exemplo |
de definição de |
nameFormat opcional |
Se for dado, os nós usarão essa convenção de nomenclatura em vez do formato padrão "nodearray-%d" de exemplo |
corda |
nameOffset opcional |
Se fornecido, juntamente com nameFormat, desloca o nodeindex para novos nós. de exemplo |
inteiro |
nodeAttributes opcional |
Atributos adicionais a serem definidos em cada nó desse conjunto de exemplo |
Node |
de nodearray necessária |
O nome do nodearray do qual iniciar nós de exemplo |
corda |
placementGroupId opcional |
Se fornecido, os nós com o mesmo valor para groupId serão todos iniciados no mesmo grupo de posicionamento. de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
machineType opcional |
de exemplo |
corda |
NodeCreationResult
Nome | Descrição | Esquema |
---|---|---|
operationId necessária |
A ID desta operação de exemplo |
corda |
define necessária |
Uma matriz de conjuntos, na mesma ordem que na solicitação de exemplo |
< define> matriz |
Nome | Descrição | Esquema |
---|---|---|
adicionado necessária |
Quantos nós foram iniciados neste conjunto de exemplo |
inteiro |
de mensagem opcional |
Indica por que nem todos os nós solicitados podem ser adicionados, se presentes de exemplo |
corda |
NodeList
Resultados de uma pesquisa de nó
Nome | Descrição | Esquema |
---|---|---|
nós necessária |
Os nós retornados de exemplo |
matriz |
de operação opcional |
Se a consulta incluir uma ID de operação, esse será o status dessa operação de exemplo |
|
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.
Nome | 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. de exemplo |
corda |
nomes de host opcional |
Uma lista de nomes de host curtos (sem domínio) para gerenciar de exemplo |
< matriz de > de cadeia de caracteres |
IDs opcional |
Uma lista de IDs de nó a serem gerenciadas de exemplo |
< matriz de > de cadeia de caracteres |
ip_addresses opcional |
Uma lista de endereços IP a serem gerenciados de exemplo |
< matriz de > de cadeia de caracteres |
nomes opcional |
Uma lista de nomes de nó a serem gerenciados de exemplo |
< matriz de > de cadeia de caracteres |
requestId opcional |
Token exclusivo fornecido pelo usuário opcional para impedir operações duplicadas em caso de erros de comunicação de rede. Se isso for incluído e corresponder a uma ID de solicitação anterior, o servidor ignorará essa solicitação e retornará um erro 409. de exemplo |
corda |
NodeManagementResult
Nome | Descrição | Esquema |
---|---|---|
nós necessária |
Uma matriz de informações sobre cada nó que correspondeu ao filtro na solicitação de gerenciamento. O status de cada nó indica se ele foi afetado pela solicitação. de exemplo |
< nós> matriz |
operationId necessária |
A ID desta operação de exemplo |
corda |
Nome | Descrição | Esquema |
---|---|---|
de erro opcional |
Se o status for Erro, isso conterá a mensagem de erro de exemplo |
corda |
de ID necessária |
A ID do nó de exemplo |
corda |
nome necessária |
O nome do nó de exemplo |
corda |
status opcional |
Um de OK ou Erro de exemplo |
enum (OK, Erro) |
OperationStatus
O status dessa operação de nó
Nome | Descrição | Esquema |
---|---|---|
de ação necessária |
de exemplo |
enumeração (criar) |
startTime necessária |
Quando esta operação foi enviada de exemplo |
cadeia de caracteres (data e hora) |