createInstance - Elasticsearch - Centre de documentation Alibaba Cloud

Notes d'utilisation

Vous maîtrisez les standards de facturation et de tarification d'Alibaba Cloud Elasticsearch. Pour plus d'informations, consultez la page Tarification d'Alibaba Cloud Elasticsearch.
Vous avez passé la vérification d'identité réelle.
Il n'est pas nécessaire de spécifier une zone lors de la création d'un cluster. Par défaut, le cluster est déployé dans la même zone que le réseau privé virtuel (VPC) spécifié.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

En-têtes de requête

Cette opération ne possède pas d'en-têtes de requête spécifiques et utilise uniquement les en-têtes de requête communs. Pour plus d'informations, consultez la section En-têtes de requête communs.

Syntaxe de la requête

POST /openapi/instances HTTP/1.1

Paramètres de requête

Paramètre	Type	Emplacement	Obligatoire	Exemple	Description
clientToken	String	Query	Non.	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique parmi différentes requêtes. Le jeton ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.
	Object	Body	Non		Les paramètres de la requête.
zoneCount	Integer	Body	Non.	2	Le nombre de zones pour le déploiement du cluster. Valeurs valides : 1, 2 et 3. Valeur par défaut : 1.
paymentType	String	Body	Non	postpaid	La méthode de facturation. Valeurs valides : postpaid : paiement à l'utilisation prepaid : abonnement
paymentInfo	PaymentInfo	Body	Non		Les détails de facturation du cluster. Ce paramètre est obligatoire si vous définissez paymentType sur prepaid.
nodeAmount	Integer	Body	Oui	3	Le nombre de nœuds de données. Valeurs valides : de 2 à 50.
instanceCategory	String	Body	Non	advanced	Type de version : x-pack : Créez une instance de l'édition commerciale ou une instance de l'édition améliorée du noyau avec Indexing Service et OpenStore désactivés. IS : Créez une instance améliorée du noyau avec Indexing Service ou OpenStore activés.
esAdminPassword	String	Body	Oui	Es_password	Le mot de passe utilisé pour accéder au cluster. Il doit comporter entre 8 et 32 caractères et contenir au moins trois types de caractères parmi les suivants : lettres majuscules, lettres minuscules, chiffres et caractères spéciaux. Les caractères spéciaux pris en charge sont les suivants : ! @ # $ % ^ & * ( ) _ + - =
esVersion	String	Body	Oui	5.5.3_with_X-Pack	La version de l'instance. Valeurs valides : 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 Remarque Les versions précédentes peuvent ne pas inclure toutes les versions prises en charge par l'instance Elasticsearch. Vous pouvez appeler l'opération GetRegionConfiguration pour afficher les versions prises en charge.
nodeSpec	NodeSpec	Body	Non		Les configurations des nœuds de données. Remarque Lorsque vous utilisez createInstance pour créer une nouvelle génération de nœuds de données basés sur des disques dans les régions Chine (Pékin), Chine (Shanghai), Chine (Hangzhou) et Chine (Shenzhen), vous devez spécifier la famille d'instances et ajouter le suffixe `.new`, par exemple Elasticsearch.sn1ne.large.new.
masterConfiguration	MasterNodeConfiguration	Body	Non		Les configurations des nœuds maîtres dédiés. Remarque Lorsque vous utilisez createInstance pour créer une nouvelle génération de nœuds de données basés sur des disques dans les régions Chine (Pékin), Chine (Shanghai), Chine (Hangzhou) et Chine (Shenzhen), vous devez spécifier la famille d'instances et ajouter le suffixe `.new`, par exemple Elasticsearch.sn1ne.large.new.
warmNodeConfiguration	WarmNodeConfiguration	Body	Non		Les configurations des nœuds chauds.
clientNodeConfiguration	ClientNodeConfiguration	Body	Non		Les configurations des nœuds clients.
elasticDataNodeConfiguration	ElasticDataNodeConfiguration	Body	Non		Les configurations des nœuds élastiques.
kibanaConfiguration	KibanaNodeConfiguration	Body	Non		Les configurations des nœuds Kibana. Remarque Nous vous recommandons vivement d'activer le nœud Kibana.
networkConfig	NetworkConfig	Body	Oui		Les configurations réseau. Remarque Vous ne pouvez pas spécifier de liste d'autorisation IP lors de la création d'une instance.
resourceGroupId	String	Body	Non	rg-aekzu7tsu4n****	L'ID du groupe de ressources auquel appartient l'instance.
description	String	Body	Non	es	Le nom de l'instance.
tags	Array	Body	Non		Le groupe de tags de l'instance.
tagKey	String	Body	Non	KeyTest	La clé du tag de l'instance.
tagValue	String	Body	Non	KeyValue	La valeur du tag de l'instance.

Remarque

Pour consulter la liste des spécifications de nœuds prises en charge par Alibaba Cloud Elasticsearch, reportez-vous aux pages Tarification d'Alibaba Cloud Elasticsearch et Spécifications.
Le paramètre diskType spécifie le type de stockage du nœud. Ce paramètre est requis pour les disques de base. Il n'est pas requis pour les disques locaux.

Exemples de corps de requête :

Créez une instance de l'édition professionnelle générale contenant à la fois des nœuds chauds et froids.

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

Créez une instance de la série Indexing Service contenant uniquement des nœuds chauds.

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

Créez une instance de la série Indexing Service contenant uniquement des nœuds froids.

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

Créez une instance de la série Indexing Service contenant à la fois des nœuds chauds et froids.

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

Créez une instance de la série Indexing Service, activez le stockage OpenStore et incluez à la fois des nœuds froids et chauds.

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

Créez une instance de la série Indexing Service, activez OpenStore et incluez des nœuds partagés chauds et froids.

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

Créez une instance Universal Business Edition 7.10 et activez le renouvellement automatique.

Remarque

Si paymentType est défini sur prepaid, l'instance est en mode abonnement. Le renouvellement automatique est configuré dans le paramètre 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"
}

Paramètres de réponse

Paramètre

Type

Exemple

Description

RequestId

String

838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3

L'ID de la requête.

Result

object

Les données renvoyées.

└instanceId

string

es-is-0u2ecp69tt****

L'ID de l'instance DTS.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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>

JSON format

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

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

Code d'erreur

Pour obtenir la liste des codes d'erreur, consultez la page Codes d'erreur de service.