すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:GetRegionConfiguration

最終更新日:Mar 17, 2025

現在のリージョン内の構成情報をクエリします。この操作は、現在のリージョン内のすべての構成情報を返します。情報は参照用です。コンソールおよび購入ページの実際の情報が優先されます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通のリクエストヘッダー」をご参照ください。

リクエスト構文

GET /openapi/region HTTP/1.1

リクエストパラメーター

パラメーター

タイプ

位置

必須

説明

zoneId String Query いいえ cn-hangzhou-f

現在のゾーンの ID。

レスポンスパラメーター

パラメーター

タイプ

説明

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6F******

リクエスト ID。

Result Object

返された構成情報。

env String production

環境タイプ。

regionId String cn-hangzhou

リージョン ID。

createUrl String https://common-buy-intl.alibabacloud.com/?commodityCode=elasticsearch&orderType=BUY#/buy

購入ページのアドレス。

dataDiskList Array of dataDiskList

データノードに許可されているディスク構成。

scaleLimit Integer 2048

連続したディスクサイズが許可されている場合の最大ディスクサイズ。

minSize Integer 20

ディスクに許可されている最小値。単位:GB。

maxSize Integer 5120

許可されている最大ディスクサイズ。

diskType String cloud_ssd

ディスクのストレージタイプ。

valueLimitSet Array of String [2560,3072,3584,4096,4608,5120]

ディスクで許可される個別値。

esVersionsLatestList Array of esVersionsLatestList

サポートされている Elasticsearch バージョンのリスト。

key String 5.5_with_X-Pack

サポートされているメジャーバージョン。

value String 5.5.3_with_X-Pack

サポートされているマイナーバージョン。

nodeSpecList Array of nodeSpecList

データノード仕様のリスト。

memorySize Integer 64

ノードあたりのメモリサイズ。

cpuCount Integer 16

仕様カテゴリでサポートされている vCPU の数。

diskType String local_efficiency

ディスクのストレージタイプ。

spec String elasticsearch.sn2ne.large

仕様の単位。

disk Integer 44000

仕様カテゴリでサポートされているディスクサイズ。

specGroupType String local_efficiency

ストレージタイプ。有効な値:

  • common: クラウドディスク
  • local_efficiency: ローカル SATA ディスク
  • local_ssd: ローカル SSD
enable Boolean true

購入がサポートされているかどうかを示します。有効な値:

  • true: ジョブを再実行できます。
  • false: ジョブを再実行できません。
clientNodeDiskList Array of disk

クライアントノードに許可されているディスク構成。

scaleLimit Integer 18

連続したディスクサイズが許可されている場合の最大ディスクサイズ。

minSize Integer 20

許可されている最小ディスクサイズ。

maxSize Integer 20

許可されている最大ディスクサイズ。

diskType String cloud_efficiency

ディスクのストレージタイプ。

masterDiskList Array of disk

専用マスターノードに許可されているディスク構成。

scaleLimit Integer 20

連続したディスクサイズが許可されている場合の最大ディスクサイズ。

minSize Integer 20

許可されている最小ディスクサイズ。

maxSize Integer 20

許可されている最大ディスクサイズ。

diskType String cloud_ssd

ディスクのストレージタイプ。次の 3 つのタイプが返されます。

  • common: クラウドディスク
  • local_efficiency: ローカル SATA ディスク
  • local_ssd: ローカル SSD
supportVersions Array of CategoryEntity

サポートされているバージョン。

instanceCategory String x-pack

エディション。有効な値:

  • advanced: Advanced Edition
  • x-pack: Standard Edition
supportVersionList Array of VersionEntity

サポートされている Elasticsearch バージョンに関する情報。

key String 5.5

購入ページでサポートされているバージョン。

value String 5.5.3

詳細なバージョン番号。

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

専用マスターノードの仕様。

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

調整ノードの仕様。

zones Array of String ["cn-hangzhou-b","cn-hangzhou-f"]

サポートされているゾーン。

instanceSupportNodes Array of String [ "WORKER", "WORKER_WARM", "COORDINATING", "KIBANA", "MASTER", "ELASTIC_WORKER" ]

リージョンで使用可能なインスタンスノードのタイプ。

esVersions Array of String [ "5.5.3_with_X-Pack"]

作成が許可されている Elasticsearch バージョンのリスト。

node Object

ノードの構成。

maxAmount Integer 50

許可されているデータノードの最大数。

minAmount Integer 2

許可されているデータノードの最小数。

jvmConfine Object

JVM 関連の構成。

memory Integer 32

ガベージコレクション ( GC ) に必要な最小メモリサイズ。

supportEsVersions Array of String ["6.7.0_with_X-Pack","6.7.0_with_A-Pack","7.4.0_with_X-Pack"]

JVM リクレイムでサポートされている Elasticsearch バージョンに関する情報。

supportGcs Array of String ["CMS","G1"]

設定できる JVM コレクターのリスト。

clientNodeAmountRange Object

クライアントノード数の範囲。

maxAmount Integer 25

クライアントノードの最大数。

minAmount Integer 2

クライアントノードの最小数。

warmNodeProperties Object

ウォームノードの構成。

diskList Array of disk

ディスク構成のリスト。

scaleLimit Integer 2048

連続したディスクサイズが許可されている場合の最大ディスクサイズ。

minSize Integer 500

許可されている最小ディスクサイズ。

diskEncryption Boolean true

ディスクの暗号化が有効になっているかどうかを示します。有効な値:

  • true: ジョブを再実行できます。
  • false: ジョブを再実行できません。
maxSize Integer 5120

許可されている最大ディスクサイズ。

diskType String cloud_efficiency

ディスクのストレージタイプ。

valueLimitSet Array of String [2560,3072,3584,4096,4608,5120]

ディスクで許可される個別値。

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

コールドノードでサポートされている仕様。

amountRange Object

ノード数の範囲。

maxAmount Integer 50

ノードの最大数。

minAmount Integer 2

ノードの最小数。

kibanaNodeProperties Object

Kibana ノードの構成。

spec Array of String ["elasticsearch.n4.small","elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn1ne.large"]

設定できる仕様のリスト。

amountRange Object

ノード数の許容範囲。

maxAmount Integer 20

ノードの最大数。

minAmount Integer 1

ノードの最小数。

elasticNodeProperties Object

Elastic ノードの構成。

diskList Array of disk

ディスク構成のリスト。

scaleLimit Integer 2048

連続したディスクサイズが許可されている場合の最大ディスクサイズ。

minSize Integer 500

許可されている最小ディスクサイズ。

diskEncryption Boolean true

ディスクの暗号化が有効になっているかどうかを示します。有効な値:

  • true: ジョブを再実行できます。
  • false: ジョブを再実行できません。
maxSize Integer 5120

許可されている最大ディスクサイズ。

diskType String cloud_ssd

ディスクのストレージタイプ。

valueLimitSet Array of String [2560,3072,3584,4096,4608,5120]

ディスクで許可される個別値。

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

ノードの仕様。

amountRange Object

ウォームノード数の範囲。

maxAmount Integer 25

ノードの最大数。

minAmount Integer 2

ノードの最小数。

説明 上記のサンプル値は参照用であり、API 操作の実際の戻り値によって異なります。

サンプルリクエスト

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

サンプルの成功レスポンス

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

HTTP ステータスコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。