Elasticsearch:UpdateInstance

Notes d'utilisation :

• Les instances dont l'état est Activating, Invalid ou Inactive ne peuvent pas être reconfigurées.

• Si votre cluster ne comporte aucun shard réplica et subit une charge élevée, les accès peuvent expirer pendant les modifications de configuration. Configurez un mécanisme de nouvelle tentative sur votre client avant d'effectuer des changements.

• Une seule requête ne peut modifier qu'un seul type de nœud à la fois : données, master dédié, données froides, coordinateur, Kibana ou elastic.

• Depuis mai 2021, Alibaba Cloud Elasticsearch a abandonné les instances 1 cœur 2 Go, les instances de nœud master dédié 2 cœurs 2 Go et les instances de version 7.4. Si vos spécifications ne sont plus disponibles, prenez les mesures suivantes :

  • Pour les spécifications 1 cœur 2 Go et 2 cœurs 2 Go, effectuez une mise à niveau vers une spécification prise en charge sur la page d'achat. Spécifications disponibles : Paramètres de la page d'achat.

  • Pour les clusters de version 7.4, achetez un cluster V7.10 et migrez vos données.

Mettre à niveau un cluster | Rétrograder un cluster.

En-têtes de requête

Cette opération utilise uniquement les en-têtes de requête courants. Consultez les paramètres de requête courants.

Syntaxe de la requête

PUT /openapi/instances/{InstanceId} HTTP/1.1

Paramètres de requête

Spécifications de nœud prises en charge : Tarification Elasticsearch et spécifications du produit.

Exemples de corps de requête :

Mise à niveau

• Augmenter l'espace de stockage

  Les augmentations d'espace de stockage s'appliquent uniquement aux nœuds de données, aux nœuds de données froides et aux nœuds de données elastic.

  Augmentez le stockage du nœud de données froides à 1000 GiB :

  
  {
    "warmNodeConfiguration": {
     "disk": 1000
    }
  }
  

• Mettre à niveau le type de stockage

  Les mises à niveau du type de stockage s'appliquent uniquement aux nœuds de données, aux nœuds de données elastic et aux nœuds masters dédiés.

  • Mettez à niveau le stockage du nœud master dédié vers Enhanced SSD :

    
    {
      "masterConfiguration": {
        "diskType": "cloud_essd"
      }
    }
    

  • Mettez à niveau un nœud master doté d'un stockage Enhanced SSD vers le niveau de performance PL3 :

    Lorsque performanceLevel est spécifié, diskType prend par défaut la valeur cloud_essd.

    Lorsque cloud_essd est spécifié, performanceLevel prend par défaut la valeur PL1.

    
    	{
    	  "masterConfiguration": {
    		"performanceLevel": "PL3"
    	  }
    	}
    	

• Augmenter le nombre de nœuds

  S'applique uniquement aux nœuds de données, aux nœuds de données froides, aux nœuds de données elastic et aux nœuds coordinateurs.

  Les nœuds de données utilisent une méthode différente de celle des autres types de nœuds :

  • Augmentez le nombre de nœuds de données à 12 :

    
    {
      "nodeAmount": 12
    }
    

  • Augmentez les autres types de nœuds (par exemple, les nœuds de données froides) à 12 :

    
    {
      "warmNodeConfiguration": {
        "amount": 12
      }
    }
    

• Mettre à niveau les spécifications des nœuds

  Mettez à niveau les spécifications des nœuds de données vers 4 vCPU et 32 Go :

  
  {
    "nodeSpec": {
      "spec": "elasticsearch.r5.xlarge"
    }
  }
  

• Mettre à niveau plusieurs configurations simultanément

  Incluez toutes les modifications de configuration pour le même type de nœud dans un seul corps de requête.

  • Augmentez le nombre de nœuds coordinateurs à 8 et mettez-les à niveau vers 4 vCPU et 8 Go :

    
    {
      "clientNodeConfiguration": {
        "amount": 8,
        "spec": "elasticsearch.sn1ne.xlarge"
      }
    }
    

  • Augmentez le nombre de nœuds de données à 12 et mettez à niveau le stockage vers Enhanced SSD :

    
    {
      "nodeAmount": 12,
      "nodeSpec": {
        "diskType": "cloud_essd"
      }
    }
    

• Activer un nœud

  Pour connaître les configurations complètes des nœuds, consultez l'API CreateInstance.

  • Activez et configurez les nœuds coordinateurs :

    
    {
      "clientNodeConfiguration": {
        "amount": 5,
        "disk": 20,
        "spec": "elasticsearch.sn1ne.xlarge"
      }
    }
    

  • Activez et configurez les nœuds de données elastic (site Chine uniquement) :

    
    {
      "elasticNodeConfiguration": {
        "disk": 200,
        "amount": 5,
        "diskType": "cloud_essd",
        "spec": "elasticsearch.sn1ne.xlarge"
      }
    }
    

  • Activez et configurez les nœuds de données froides :

    
    {
      "warmNodeConfiguration": {
        "disk": 1000,
        "amount": 3,
        "spec": "elasticsearch.sn1ne.xlarge"
      }
    }
    

• Mettre à niveau OpenStore (site Chine uniquement)

  Les instances dotées de nœuds de données froides ou d'un stockage de nœud de données Enhanced SSD ne peuvent pas activer OpenStore.

  L'activation d'OpenStore sur une instance Standard Business Edition la met à niveau vers Log Enhanced Edition avec Indexing Service.

  • Activez OpenStore sur un nœud de données froides :

    
    {
      "warmNodeConfiguration": {
        "amount": 5,
        "spec": "openstore.i2g.4xlarge"
      }
    }
    

  • Convertir les spécifications des nœuds de données vers OpenStore :

    
    {
      "nodeAmount": 6,
      "nodeSpec": {
        "spec": "openstore.i2g.4xlarge",
        "diskType": "cloud_ssd",
        "disk": 100
      }
    }
    

• Spécifier la méthode de changement

  • Le mode par défaut est le changement intelligent. Vous pouvez spécifier blue-green (blue_green) ou in-place (normal) :

    
    {
      "nodeSpec": {
        "spec": "elasticsearch.r5.xlarge"
      },
      "updateType": "blue_green" ## Change the value to normal. 
    }
    

  • Forcer un changement :

    
    {
      "nodeSpec": {
        "spec": "elasticsearch.r5.xlarge"
      },
      "force": true
    }
    

• Pré-vérification de la configuration par test à blanc (dry-run)

  Ajoutez dryRun au corps de la requête :

  
  {
    "nodeSpec": {
      "spec": "elasticsearch.r5.xlarge"
    },
    "dryRun": true
  }
  

Rétrogradation

• Rétrograder le type de stockage

  Les rétrogradations du type de stockage ne s'appliquent pas aux nœuds de données froides, aux nœuds coordinateurs ou aux nœuds Kibana.

  Rétrogradez le stockage du nœud master dédié vers SSD :

  
  {
    "masterConfiguration": {
      "diskType": "cloud_ssd"
    }
  }
  

• Rétrograder les spécifications

  Rétrogradez les spécifications des nœuds de données vers 4 vCPU et 32 Go :

  
  {
    "nodeSpec": {
      "spec": "elasticsearch.r5.xlarge"
    }
  }
  

Paramètres de réponse

Exemples

Exemple de requête

PUT /openapi/instances/es-cn-n6w1ptcb30009****?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&orderActionType=upgrade HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "nodeSpec": {
    "spec": "elasticsearch.r5.xlarge"
  }
}

Exemples de réponses réussies

JSON format

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

{
  "Result" : {
    "instanceId" : "es-cn-n6w1ptcb30009****",
    "version" : "5.5.3_with_X-Pack",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "nodeSpec" : {
      "spec" : "elasticsearch.n4.small",
      "disk" : 40,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "createdAt" : "2020-06-28T08:25:52.895Z",
    "zoneCount" : 1,
    "instanceCategory" : "x-pack",
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    }
  },
  "RequestId" : "B5246080-9C30-4B6A-8F8A-8C705405****"
}

Description de l'exemple de réponse

> In the return example, this article only guarantees that the parameters in the return data list are included, and the parameters not mentioned are for reference only. The program cannot force to rely on obtaining these parameters. 

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.