GetRegionConfiguration - Consultar configuração de região do Elasticsearch - Elasticsearch: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Execute esta operação no OpenAPI Explorer para gerar dinamicamente códigos de exemplo do SDK.

Cabeçalhos da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns.

Sintaxe da requisição

GET /openapi/region HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
zoneId	String	Query	Não	cn-hangzhou-f	ID da zona.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6F******	ID da requisição.
Result	Object		Configuração retornada.
env	String	production	Tipo de ambiente.
regionId	String	cn-hangzhou	ID da região.
createUrl	String	https://common-buy-intl.alibabacloud.com/?commodityCode=elasticsearch&orderType=BUY#/buy	URL da página de compra.
dataDiskList	Array of dataDiskList		Configurações de disco permitidas para nós de dados.
scaleLimit	Integer	2048	Tamanho máximo de disco para dimensionamento contínuo.
minSize	Integer	20	Tamanho mínimo do disco. Unidade: GB.
maxSize	Integer	5120	Tamanho máximo do disco.
diskType	String	cloud_ssd	Tipo de disco.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tamanhos de disco discretos permitidos.
esVersionsLatestList	Array of esVersionsLatestList		Versões do Elasticsearch compatíveis.
key	String	5.5_with_X-Pack	Versão principal compatível.
value	String	5.5.3_with_X-Pack	Versão secundária compatível.
nodeSpecList	Array of nodeSpecList		Especificações dos nós de dados.
memorySize	Integer	64	Tamanho de memória por nó.
cpuCount	Integer	16	Número de vCPUs.
diskType	String	local_efficiency	Tipo de disco.
spec	String	elasticsearch.sn2ne.large	ID da especificação.
disk	Integer	44000	Tamanho do disco para esta especificação.
specGroupType	String	local_efficiency	Tipo de armazenamento. Valores válidos: common: disco em nuvem local_efficiency: disco SATA local local_ssd: SSD local
enable	Boolean	true	Indica se há suporte para compra. Valores válidos: true: há suporte para compra. false: não há suporte para compra.
clientNodeDiskList	Array of disk		Configurações de disco permitidas para nós clientes.
scaleLimit	Integer	18	Tamanho máximo de disco para dimensionamento contínuo.
minSize	Integer	20	Tamanho mínimo do disco.
maxSize	Integer	20	Tamanho máximo do disco.
diskType	String	cloud_efficiency	Tipo de disco.
masterDiskList	Array of disk		Configurações de disco permitidas para nós mestres dedicados.
scaleLimit	Integer	20	Tamanho máximo de disco para dimensionamento contínuo.
minSize	Integer	20	Tamanho mínimo do disco.
maxSize	Integer	20	Tamanho máximo do disco.
diskType	String	cloud_ssd	Tipo de disco. Valores válidos: common: disco em nuvem local_efficiency: disco SATA local local_ssd: SSD local
supportVersions	Array of CategoryEntity		Versões do Elasticsearch compatíveis por edição.
instanceCategory	String	x-pack	Edição. Valores válidos: advanced: Advanced Edition x-pack: Standard Edition
supportVersionList	Array of VersionEntity		Detalhes das versões compatíveis.
key	String	5.5	Versão na página de compra.
value	String	5.5.3	Número detalhado da versão.
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" ]	Especificações de nós mestres dedicados.
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"]	Especificações de nós clientes.
zones	Array of String	["cn-hangzhou-b","cn-hangzhou-f"]	Zonas compatíveis.
instanceSupportNodes	Array of String	[ "WORKER", "WORKER_WARM", "COORDINATING", "KIBANA", "MASTER", "ELASTIC_WORKER" ]	Tipos de nós disponíveis nesta região.
esVersions	Array of String	[ "5.5.3_with_X-Pack"]	Versões do Elasticsearch disponíveis para criação de cluster.
node	Object		Intervalo de quantidade de nós de dados.
maxAmount	Integer	50	Número máximo de nós de dados.
minAmount	Integer	2	Número mínimo de nós de dados.
jvmConfine	Object		Configurações da JVM.
memory	Integer	32	Tamanho mínimo de memória GC.
supportEsVersions	Array of String	["6.7.0_with_X-Pack","6.7.0_with_A-Pack","7.4.0_with_X-Pack"]	Versões do Elasticsearch com suporte à configuração de GC da JVM.
supportGcs	Array of String	["CMS","G1"]	Coletores de lixo da JVM compatíveis.
clientNodeAmountRange	Object		Intervalo de quantidade de nós clientes.
maxAmount	Integer	25	Número máximo de nós clientes.
minAmount	Integer	2	Número mínimo de nós clientes.
warmNodeProperties	Object		Configurações de nós warm.
diskList	Array of disk		Configurações de disco.
scaleLimit	Integer	2048	Tamanho máximo de disco para dimensionamento contínuo.
minSize	Integer	500	Tamanho mínimo do disco.
diskEncryption	Boolean	true	Indica se a criptografia de disco está ativada. Valores válidos: true: criptografia ativada. false: criptografia desativada.
maxSize	Integer	5120	Tamanho máximo do disco.
diskType	String	cloud_efficiency	Tipo de disco.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tamanhos de disco discretos permitidos.
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"]	Especificações de nós warm compatíveis.
amountRange	Object		Intervalo de quantidade de nós.
maxAmount	Integer	50	Máximo de nós.
minAmount	Integer	2	Mínimo de nós.
kibanaNodeProperties	Object		Configurações de nós Kibana.
spec	Array of String	["elasticsearch.n4.small","elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn1ne.large"]	Especificações de nós Kibana compatíveis.
amountRange	Object		Intervalo de quantidade de nós.
maxAmount	Integer	20	Máximo de nós.
minAmount	Integer	1	Mínimo de nós.
elasticNodeProperties	Object		Configurações de nós elásticos.
diskList	Array of disk		Configurações de disco.
scaleLimit	Integer	2048	Tamanho máximo de disco para dimensionamento contínuo.
minSize	Integer	500	Tamanho mínimo do disco.
diskEncryption	Boolean	true	Indica se a criptografia de disco está ativada. Valores válidos: true: criptografia ativada. false: criptografia desativada.
maxSize	Integer	5120	Tamanho máximo do disco.
diskType	String	cloud_ssd	Tipo de disco.
valueLimitSet	Array of String	[2560,3072,3584,4096,4608,5120]	Tamanhos de disco discretos permitidos.
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"]	Especificações de nós elásticos compatíveis.
amountRange	Object		Intervalo de quantidade de nós elásticos.
maxAmount	Integer	25	Máximo de nós.
minAmount	Integer	2	Mínimo de nós.

Nota

Os valores de exemplo acima servem apenas como referência. Prevalecem os valores reais.

Exemplos

Exemplo de requisição

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

Exemplo de resposta de sucesso

Formato JSON

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

Código de status HTTP

Para códigos de erro, visite Códigos de erro do serviço.