GetRegionConfiguration - Query Elasticsearch region configuration - Elasticsearch

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Appelez cette opération dans OpenAPI Explorer pour générer dynamiquement un exemple de code SDK.

En-têtes de requête

Cette opération utilise uniquement des en-têtes de requête communs.

Syntaxe de la requête

GET /openapi/region HTTP/1.1

Paramètres de requête

Paramètre

Type

Position

Obligatoire

Exemple

Description

zoneId

String

Query

Non

cn-hangzhou-f

ID de la zone.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6F******	ID de la requête.
Result	Object		Configuration renvoyée.
env	String	production	Type d'environnement.
regionId	String	cn-hangzhou	ID de la région.
createUrl	String	https://common-buy-intl.alibabacloud.com/?commodityCode=elasticsearch&orderType=BUY#/buy	URL de la page d'achat.
dataDiskList	Array of dataDiskList		Configurations de disque autorisées pour les nœuds de données.
scaleLimit	Integer	2048	Taille maximale du disque pour la mise à l'échelle continue.
minSize	Integer	20	Taille minimale du disque. Unité : Go.
maxSize	Integer	5120	Taille maximale du disque.
diskType	String	cloud_ssd	Type de disque.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tailles de disque discrètes autorisées.
esVersionsLatestList	Array of esVersionsLatestList		Versions Elasticsearch prises en charge.
key	String	5.5_with_X-Pack	Version majeure prise en charge.
value	String	5.5.3_with_X-Pack	Version mineure prise en charge.
nodeSpecList	Array of nodeSpecList		Spécifications des nœuds de données.
memorySize	Integer	64	Taille de la mémoire par nœud.
cpuCount	Integer	16	Nombre de vCPU.
diskType	String	local_efficiency	Type de disque.
spec	String	elasticsearch.sn2ne.large	ID de la spécification.
disk	Integer	44000	Taille du disque pour cette spécification.
specGroupType	String	local_efficiency	Type de stockage. Valeurs valides : common : disque cloud local_efficiency : disque SATA local local_ssd : SSD local
enable	Boolean	true	Indique si l'achat est pris en charge. Valeurs valides : true : La tâche peut être réexécutée. false : La tâche ne peut pas être réexécutée.
clientNodeDiskList	Array of disk		Configurations de disque autorisées pour les nœuds clients.
scaleLimit	Integer	18	Taille maximale du disque pour la mise à l'échelle continue.
minSize	Integer	20	Taille minimale du disque.
maxSize	Integer	20	Taille maximale du disque.
diskType	String	cloud_efficiency	Type de disque.
masterDiskList	Array of disk		Configurations de disque autorisées pour les nœuds maîtres dédiés.
scaleLimit	Integer	20	Taille maximale du disque pour la mise à l'échelle continue.
minSize	Integer	20	Taille minimale du disque.
maxSize	Integer	20	Taille maximale du disque.
diskType	String	cloud_ssd	Type de disque. Valeurs valides : common : disque cloud local_efficiency : disque SATA local local_ssd : SSD local
supportVersions	Array of CategoryEntity		Versions Elasticsearch prises en charge par édition.
instanceCategory	String	x-pack	Édition. Valeurs valides : advanced : Édition Advanced x-pack : Édition Standard
supportVersionList	Array of VersionEntity		Détails des versions prises en charge.
key	String	5.5	Version sur la page d'achat.
value	String	5.5.3	Numéro de version détaillé.
masterSpec	Array of String	["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge" ]	Spécifications des nœuds maîtres dédiés.
clientNodeSpec	Array of String	["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]	Spécifications des nœuds clients.
zones	Array of String	["cn-hangzhou-b","cn-hangzhou-f"]	Zones prises en charge.
instanceSupportNodes	Array of String	[ "WORKER", "WORKER_WARM", "COORDINATING", "KIBANA", "MASTER", "ELASTIC_WORKER" ]	Types de nœuds disponibles dans cette région.
esVersions	Array of String	[ "5.5.3_with_X-Pack"]	Versions Elasticsearch disponibles pour la création de cluster.
node	Object		Plage du nombre de nœuds de données.
maxAmount	Integer	50	Nombre maximal de nœuds de données.
minAmount	Integer	2	Nombre minimal de nœuds de données.
jvmConfine	Object		Configurations JVM.
memory	Integer	32	Taille minimale de la mémoire GC.
supportEsVersions	Array of String	["6.7.0_with_X-Pack","6.7.0_with_A-Pack","7.4.0_with_X-Pack"]	Versions Elasticsearch qui prennent en charge la configuration JVM GC.
supportGcs	Array of String	["CMS","G1"]	Collecteurs de garbage JVM pris en charge.
clientNodeAmountRange	Object		Plage du nombre de nœuds clients.
maxAmount	Integer	25	Nombre maximal de nœuds clients.
minAmount	Integer	2	Nombre minimal de nœuds clients.
warmNodeProperties	Object		Configurations des nœuds chauds.
diskList	Array of disk		Configurations de disque.
scaleLimit	Integer	2048	Taille maximale du disque pour la mise à l'échelle continue.
minSize	Integer	500	Taille minimale du disque.
diskEncryption	Boolean	true	Indique si le chiffrement du disque est activé. Valeurs valides : true : La tâche peut être réexécutée. false : La tâche ne peut pas être réexécutée.
maxSize	Integer	5120	Taille maximale du disque.
diskType	String	cloud_efficiency	Type de disque.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tailles de disque discrètes autorisées.
spec	Array of String	["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]	Spécifications des nœuds chauds prises en charge.
amountRange	Object		Plage du nombre de nœuds.
maxAmount	Integer	50	Nombre maximal de nœuds.
minAmount	Integer	2	Nombre minimal de nœuds.
kibanaNodeProperties	Object		Configurations des nœuds Kibana.
spec	Array of String	["elasticsearch.n4.small","elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn1ne.large"]	Spécifications des nœuds Kibana prises en charge.
amountRange	Object		Plage du nombre de nœuds.
maxAmount	Integer	20	Nombre maximal de nœuds.
minAmount	Integer	1	Nombre minimal de nœuds.
elasticNodeProperties	Object		Configurations des nœuds Elastic.
diskList	Array of disk		Configurations de disque.
scaleLimit	Integer	2048	Taille maximale du disque pour la mise à l'échelle continue.
minSize	Integer	500	Taille minimale du disque.
diskEncryption	Boolean	true	Indique si le chiffrement du disque est activé. Valeurs valides : true : La tâche peut être réexécutée. false : La tâche ne peut pas être réexécutée.
maxSize	Integer	5120	Taille maximale du disque.
diskType	String	cloud_ssd	Type de disque.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tailles de disque discrètes autorisées.
spec	Array of String	["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]	Spécifications des nœuds Elastic prises en charge.
amountRange	Object		Plage du nombre de nœuds Elastic.
maxAmount	Integer	25	Nombre maximal de nœuds.
minAmount	Integer	2	Nombre minimal de nœuds.

Remarque

Les exemples de valeurs ci-dessus sont fournis à titre indicatif uniquement. Seules les valeurs réelles font foi.

Exemples

Exemple de requête

GET /openapi/region?zoneId=cn-hangzhou-f HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemple de réponse en cas de succès

JSON format

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

{
  "RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6F******",
  "Result" : {
    "regionId" : "cn-hangzhou",
    "createUrl" : "https://common-buy-intl.alibabacloud.com/?commodityCode=elasticsearch&amp;orderType=BUY#/buy",
    "env" : "production",
    "dataDiskList" : {
      "scaleLimit" : 2048,
      "maxSize" : 5120,
      "minSize" : 20,
      "diskType" : "cloud_ssd",
      "valueLimitSet" : "[2560,3072,3584,4096,4608,5120]"
    },
    "supportVersions" : {
      "instanceCategory" : "x-pack",
      "supportVersionList" : {
        "value" : "5.5.3",
        "key" : 5.5
      }
    },
    "nodeSpecList" : {
      "disk" : 44000,
      "memorySize" : 64,
      "enable" : true,
      "diskType" : "local_efficiency",
      "specGroupType" : "local_efficiency",
      "spec" : "elasticsearch.sn2ne.large",
      "cpuCount" : 16
    },
    "clientNodeDiskList" : {
      "scaleLimit" : 18,
      "maxSize" : 20,
      "minSize" : 20,
      "diskType" : "cloud_efficiency"
    },
    "esVersionsLatestList" : {
      "value" : "5.5.3_with_X-Pack",
      "key" : "5.5_with_X-Pack"
    },
    "masterDiskList" : {
      "scaleLimit" : 20,
      "maxSize" : 20,
      "minSize" : 20,
      "diskType" : "cloud_ssd"
    },
    "zones" : "[\"cn-hangzhou-b\",\"cn-hangzhou-f\"]",
    "esVersions" : "[ \"5.5.3_with_X-Pack\"]",
    "masterSpec" : "[\"elasticsearch.sn2ne.large\",\"elasticsearch.sn2ne.xlarge\",\"elasticsearch.sn2ne.2xlarge\",\"elasticsearch.sn2ne.4xlarge\",\"elasticsearch.sn1ne.4xlarge\",\"elasticsearch.r5.large\",\"elasticsearch.r5.xlarge\",\"elasticsearch.r5.2xlarge\" ]",
    "clientNodeSpec" : "[\"elasticsearch.sn2ne.large\",\"elasticsearch.sn2ne.xlarge\",\"elasticsearch.sn2ne.2xlarge\",\"elasticsearch.sn2ne.4xlarge\",\"elasticsearch.sn1ne.4xlarge\",\"elasticsearch.ic5.xlarge\",\"elasticsearch.ic5.2xlarge\",\"elasticsearch.ic5.3xlarge\",\"elasticsearch.ic5.4xlarge\",\"elasticsearch.r5.large\",\"elasticsearch.r5.xlarge\",\"elasticsearch.r5.2xlarge\"]",
    "instanceSupportNodes" : "[ \"WORKER\", \"WORKER_WARM\", \"COORDINATING\", \"KIBANA\", \"MASTER\", \"ELASTIC_WORKER\" ]",
    "node" : {
      "minAmount" : 2,
      "maxAmount" : 50
    },
    "jvmConfine" : {
      "memory" : 32,
      "supportGcs" : "[\"CMS\",\"G1\"]",
      "supportEsVersions" : "[\"6.7.0_with_X-Pack\",\"6.7.0_with_A-Pack\",\"7.4.0_with_X-Pack\"]"
    },
    "clientNodeAmountRange" : {
      "minAmount" : 2,
      "maxAmount" : 25
    },
    "warmNodeProperties" : {
      "diskList" : {
        "scaleLimit" : 2048,
        "minSize" : 500,
        "maxSize" : 5120,
        "diskType" : "cloud_efficiency",
        "diskEncryption" : true,
        "valueLimitSet" : "[2560,3072,3584,4096,4608,5120]"
      },
      "spec" : "[\"elasticsearch.sn2ne.large\",\"elasticsearch.sn2ne.xlarge\",\"elasticsearch.sn2ne.2xlarge\",\"elasticsearch.sn2ne.4xlarge\",\"elasticsearch.sn1ne.8xlarge\",\"elasticsearch.ic5.large\",\"elasticsearch.ic5.xlarge\",\"elasticsearch.ic5.2xlarge\",\"elasticsearch.ic5.3xlarge\",\"elasticsearch.ic5.4xlarge\",\"elasticsearch.r5.large\",\"elasticsearch.r5.xlarge\",\"elasticsearch.r5.2xlarge\"]",
      "amountRange" : {
        "minAmount" : 2,
        "maxAmount" : 50
      }
    },
    "kibanaNodeProperties" : {
      "spec" : "[\"elasticsearch.n4.small\",\"elasticsearch.sn2ne.large\",\"elasticsearch.sn2ne.xlarge\",\"elasticsearch.sn2ne.2xlarge\",\"elasticsearch.sn1ne.large\"]",
      "amountRange" : {
        "minAmount" : 1,
        "maxAmount" : 20
      }
    },
    "elasticNodeProperties" : {
      "diskList" : {
        "scaleLimit" : 2048,
        "minSize" : 500,
        "maxSize" : 5120,
        "diskType" : "cloud_ssd",
        "diskEncryption" : true,
        "valueLimitSet" : "[2560,3072,3584,4096,4608,5120]"
      },
      "spec" : "[\"elasticsearch.sn2ne.large\",\"elasticsearch.sn2ne.xlarge\",\"elasticsearch.sn2ne.2xlarge\",\"elasticsearch.sn2ne.4xlarge\",\"elasticsearch.sn1ne.8xlarge\",\"elasticsearch.ic5.large\",\"elasticsearch.ic5.xlarge\",\"elasticsearch.ic5.2xlarge\",\"elasticsearch.ic5.3xlarge\",\"elasticsearch.ic5.4xlarge\",\"elasticsearch.r5.large\",\"elasticsearch.r5.xlarge\",\"elasticsearch.r5.2xlarge\"]",
      "amountRange" : {
        "minAmount" : 2,
        "maxAmount" : 25
      }
    }
  }
}

Code d'état HTTP

Pour les codes d'erreur, consultez les Codes d'erreur de service.