Todos os produtos
Search
Central de documentação

Elasticsearch:CapacityPlan

Última atualização: Jun 27, 2026

Retorna configurações recomendadas de planejamento de capacidade do cluster com base nos seus cenários de negócios, consultas por segundo (QPS) e volume de logs.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Cabeçalhos de requisição comuns.

Sintaxe da requisição

POST /openapi/assist/actions/capacity-plan HTTP/1.1

Parâmetros da requisição

Parâmetro Tipo Posição Obrigatório Exemplo Descrição
Object Body Não

Parâmetros da requisição.

complexQueryAvailable Boolean Body Não true

Define se consultas agregadas complexas são necessárias. Valores válidos:

  • true
  • false
dataInfo Array Body Não

Dados de uso de disco.

code String Body Não totalRawData

Código da métrica de dados de disco. Valores válidos:

  • totalRawData: informações de dados de source
  • document: informações do documento e número estimado de documentos
  • dailyIncrement: crescimento diário de dados
  • dailyIncrement: número de documentos incrementais por dia
  • retentionTime: período de retenção de dados
  • replica: configurações de réplica
size Long Body Não 100

Valor da métrica de uso de disco.

type String Body Não hot

Tipo de dados de disco. Valores válidos:

  • hot: dados quentes
  • warm: dados frios
unit String Body Não MiB

Unidade de dados ou de tempo. Valores válidos:

  • Unidades de dados: MiB, GiB, TB e PB
  • Unidades de tempo: DAYS, WEEKS, MONTHS e YEARS
totalCount Integer Body Não 10000

Número total de entradas.

metric Array Body Não

Métricas de uso de disco, status de busca e escrita, além de requisições agregadas.

code String Body Não write

Código da métrica de busca ou escrita. Valores válidos:

  • write: escrita
  • search: busca
concurrent Long Body Não 2

Número de threads simultâneas.

throughput Long Body Não 100

Throughput. Unidade: MB/s.

type String Body Não common

Tipo de pico de busca ou escrita. Valores válidos:

  • common: convencional
  • peak: pico
peakQps Integer Body Não 30

QPS de pico.

averageQps Integer Body Não 30

QPS médio.

responseTime Integer Body Não 100

Tempo médio de resposta esperado. Unidade: ms.

usageScenario String Body Não general

Cenário de uso. Valores válidos:

  • general: cenário geral
  • analysisVisualization: análise de dados
  • dbAcceleration: aceleração de banco de dados
  • search: busca
  • log: log

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
RequestId String E91B7129-A669-4D9D-A743-F90A0FF1F5EF

ID da requisição.

Result Object

Dados retornados.

ExtendConfigs Array of ExtendConfigs

Configurações de extensão.

ConfigType String sharedDisk

Tipo de configuração. Defina o valor como sharedDisk.

Nota O atributo extendConfigs pode aparecer quando o tipo de instância planejada for avançado.
Disk Long 2048

Tamanho do disco. Unidade: GiB.

DiskType String CPFS_PREMIUM

Tipo do disco. Defina o valor como CPFS_PREMIUM.

Nota O atributo extendConfigs pode aparecer quando o tipo de instância planejada for avançado.
InstanceCategory String advanced

Tipo de edição. Valores válidos:

  • advanced: Edição Avançada
  • x-pack: Edição Standard
  • community: Edição Community
NodeConfigurations Array of NodeConfigurations

Configurações do nó.

Amount Long 10

Número de núcleos.

Cpu Long 1

Número de vCPUs.

Disk Long 20

Tamanho do disco. Unidade: GiB.

DiskType String cloud_ssd

Tipo de disco. Valores válidos:

  • cloud_essd: SSD aprimorado (ESSD)
  • cloud_ssd: SSD padrão
  • cloud_efficiency: disco ultra
  • local_ssd: SSD local
  • local_efficiency: Disco Eficiente Local
Memory Long 2

Tamanho da memória da função do nó. Unidade: GB.

NodeType String WORKER

Tipo de nó. Valores válidos:

  • WORKER: nó de dados
  • WORKER_WARM: nós de dados frios
  • MASTER: nó mestre dedicado
  • KIBANA: nó Kibana
  • COORDINATING: nó cliente
  • ELASTIC_WORKER: nó elástico
OversizedCluster Boolean true

Indica se o cluster está superdimensionado conforme o planejamento de capacidade. Valores válidos:

  • true: O cluster está superdimensionado. A quantidade de nós de dados excede o limiar de 50.
  • false: A quantidade de nós de dados é inferior a 50.

Exemplos

Exemplo de requisição

POST /openapi/assist/actions/capacity-plan HTTP/1.1
Content-Type:application/json

{
  "complexQueryAvailable" : true,
  "dataInfo" : [ {
    "code" : "totalRawData",
    "size" : 100,
    "type" : "hot",
    "unit" : "MiB",
    "totalCount" : 10000
  } ],
  "metric" : [ {
    "code" : "write",
    "concurrent" : 2,
    "throughput" : 100,
    "type" : "common",
    "peakQps" : 30,
    "averageQps" : 30,
    "responseTime" : 100
  } ],
  "usageScenario" : "general"
}

Exemplo de resposta de sucesso

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E91B7129-A669-4D9D-A743-F90A0FF1F5EF",
  "Result" : {
    "instanceCategory" : "advanced",
    "oversizedCluster" : true,
    "nodeConfigurations" : [ {
      "amount" : 3943,
      "diskType" : "cloud_ssd",
      "disk" : 20,
      "nodeType" : "WORKER",
      "cpu" : 32,
      "memory" : 128
    }, {
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20,
      "nodeType" : "MASTER",
      "cpu" : 2,
      "memory" : 8
    }, {
      "amount" : 3,
      "diskType" : "cloud_efficiency",
      "disk" : 20,
      "nodeType" : "COORDINATING",
      "cpu" : 2,
      "memory" : 8
    }, {
      "amount" : 7,
      "diskType" : "cloud_efficiency",
      "nodeType" : "WORKER_WARM",
      "cpu" : 4,
      "memory" : 32
    }, {
      "amount" : 1,
      "nodeType" : "KIBANA",
      "cpu" : 1,
      "memory" : 2
    } ],
    "extendConfigs" : [ {
      "configType" : "sharedDisk",
      "diskType" : "CPFS_PREMIUM",
      "disk" : 3943000
    } ]
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.