createInstance - Elasticsearch: Central de Documentação do Alibaba Cloud

Observações de uso

Você deve conhecer bem os padrões de faturamento e preços do Alibaba Cloud Elasticsearch. Para mais informações, consulte Preços do Alibaba Cloud Elasticsearch.
Sua conta precisa ter passado pela verificação de nome real.
Não é necessário especificar uma zona ao criar um cluster. Por padrão, o cluster é implantado na mesma zona da Virtual Private Cloud (VPC) especificada.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Cabeçalhos da solicitação

Esta operação não possui cabeçalhos de solicitação específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte Cabeçalhos de solicitação comuns.

Sintaxe da solicitação

POST /openapi/instances HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
clientToken	String	Query	Não.	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token utilizado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que ele seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.
	Object	Body	Não		Os parâmetros da solicitação.
zoneCount	Integer	Body	Não.	2	Número de zonas para implantar o cluster. Valores válidos: 1, 2 e 3. Valor padrão: 1.
paymentType	String	Body	Não	postpaid	Método de faturamento. Valores válidos: postpaid: pagamento conforme o uso prepaid: assinatura
paymentInfo	PaymentInfo	Body	Não		Detalhes de faturamento do cluster. Este parâmetro é obrigatório se você definir paymentType como prepaid.
nodeAmount	Integer	Body	Sim	3	Quantidade de nós de dados. Valores válidos: 2 a 50.
instanceCategory	String	Body	Não	advanced	Tipo de versão: x-pack: Cria uma instância da Commercial Edition ou uma instância da Kernel-Enhanced Edition com Indexing Service e OpenStore desativados. IS: Cria uma instância kernel-enhanced com Indexing Service ou OpenStore ativado.
esAdminPassword	String	Body	Sim	Es_password	Senha usada para acessar o cluster. A senha deve ter de 8 a 32 caracteres e conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Os seguintes caracteres especiais são suportados: ! @ # $ % ^ & * ( ) _ + - =
esVersion	String	Body	Sim	5.5.3_with_X-Pack	Versão da instância. Valores válidos: 8.5.1_with_X-Pack 7.10_with_X-Pack 6.7_with_X-Pack 7.7_with_X-Pack 6.8_with_X-Pack 6.3_with_X-Pack 5.6_with_X-Pack 5.5.3_with_X-Pack Nota As versões acima podem não incluir todas as versões suportadas pela instância do Elasticsearch. Chame a operação GetRegionConfiguration para visualizar as versões suportadas.
nodeSpec	NodeSpec	Body	Não		Configurações dos nós de dados. Nota Ao usar createInstance para criar uma nova geração de nós de dados do tipo disco nas regiões China (Beijing), China (Shanghai), China (Hangzhou) e China (Shenzhen), você deve especificar a família da instância e o sufixo `.new`, por exemplo, Elasticsearch.sn1ne.large.new.
masterConfiguration	MasterNodeConfiguration	Body	Não		Configurações dos nós mestres dedicados. Nota Ao usar createInstance para criar uma nova geração de nós de dados do tipo disco nas regiões China (Beijing), China (Shanghai), China (Hangzhou) e China (Shenzhen), você deve especificar a família da instância e o sufixo `.new`, por exemplo, Elasticsearch.sn1ne.large.new.
warmNodeConfiguration	WarmNodeConfiguration	Body	Não		Configurações dos nós warm.
clientNodeConfiguration	ClientNodeConfiguration	Body	Não		Configurações dos nós de cliente.
elasticDataNodeConfiguration	ElasticDataNodeConfiguration	Body	Não		Configurações dos nós elásticos.
kibanaConfiguration	KibanaNodeConfiguration	Body	Não		Configurações dos nós do Kibana. Nota Recomendamos fortemente que você ative o nó do Kibana.
networkConfig	NetworkConfig	Body	Sim		Configurações de rede. Nota Não é possível especificar uma lista de permissões de endereços IP ao criar uma instância.
resourceGroupId	String	Body	Não	rg-aekzu7tsu4n****	ID do grupo de recursos ao qual a instância pertence.
description	String	Body	Não	es	Nome da instância.
tags	Array	Body	Não		Grupo de tags da instância.
tagKey	String	Body	Não	KeyTest	Chave da tag da instância.
tagValue	String	Body	Não	KeyValue	Valor da tag da instância.

Nota

Para obter uma lista de especificações de nós suportadas pelo Alibaba Cloud Elasticsearch, consulte Preços do Alibaba Cloud Elasticsearch e Especificações.
O parâmetro diskType define o tipo de armazenamento do nó. Este parâmetro é obrigatório para discos básicos, mas não é necessário para discos locais.

Exemplos de corpo da solicitação:

Crie uma instância General-purpose Business Edition que contenha nós hot e cold.

{
  "description": "xpack-hot-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "x-pack",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 20,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "elasticsearch.sn1ne.xlarge",
    "amount": 3,
    "diskType": "cloud_efficiency",
    "disk": 500
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância da série Indexing Service contendo apenas nós hot.

{
  "description": "is-hot",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn1ne.xlarge",
    "disk": 20,
    "diskType": "cloud_ssd"
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância da série Indexing Service contendo apenas nós cold.

{
  "description": "is-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "warmNodeConfiguration": {
    "spec": "group.c6.large.500",
    "amount": 3,
    "disk": 300
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância da série Indexing Service contendo nós hot e cold.

{
  "description": "is-hot-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "group.c6.large.500",
    "amount": 3,
    "disk": 300
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância da série Indexing Service, ative o armazenamento OpenStore e inclua nós cold e hot.

{
  "description": "os-1",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "openstore.i2g.4xlarge",
    "amount": 3
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância da série Indexing Service, ative o OpenStore e inclua nós compartilhados hot e cold.

{
  "description": "os-2",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "openstore.i2g.4xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Crie uma instância Universal Business Edition 7.10 e ative a renovação automática.

Nota

Se paymentType estiver definido como prepaid, a instância estará no modo de assinatura. A renovação automática é configurada no parâmetro paymentInfo.

{
 "description": "auto-renewal",
 "nodeAmount": 3,
 "instanceCategory": "x-pack",
 "esVersion": "7.10_with_X-Pack",
 "nodeSpec": {
 "spec": "elasticsearch.sn2ne.xlarge",
 "disk": 50,
 "diskType": "cloud_ssd"
 },
 "kibanaConfiguration": {
 "spec": "elasticsearch.sn1ne.large"
 },
 "networkConfig": {
 "type": "vpc",
 "vpcId": "vpc-8vbfu74bmw4m7m84a****",
 "vswitchId": "vsw-8vbnk6cmurbpump2f****",
 "vsArea": "cn-zhangjiakou-c"
 },
 "paymentType": "prepaid",
 "paymentInfo": {
 "duration": 1,
 "pricingCycle": "Month",
 "isAutoRenew": true,
 "autoRenewDuration": 1
 },
 "esAdminPassword": "yourPassword"
}

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3	ID da solicitação.
Result	object		Dados retornados.
└instanceId	string	es-is-0u2ecp69tt****	ID da instância DTS.

Exemplos

Exemplos de solicitações

POST /openapi/instances?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "description": "xpack-hot-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "x-pack",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 20,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "elasticsearch.sn1ne.xlarge",
    "amount": 3,
    "diskType": "cloud_efficiency",
    "disk": 500
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

Exemplos de respostas de sucesso

Formato XML

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

<createInstanceResponse>
    <RequestId>838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3</RequestId>
    <Result>
        <instanceId>es-is-0u2ecp69tt****</instanceId>
    </Result>
</createInstanceResponse>

Formato JSON

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

{
  "RequestId" : "838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3",
  "Result" : {
    "instanceId" : "es-is-0u2ecp69tt****"
  }
}

Código de erro

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