擷取目前範圍的開放配置資訊。介面傳回值為全量資料供參考，以控制台和售賣頁實際展示值為準。
調試
您可以在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 | 該規格對應的CPU核心數。 |
| diskType | String | local_efficiency | 磁碟儲存類型。 |
| spec | String | elasticsearch.sn2ne.large | 規格名稱。 |
| disk | Integer | 44000 | 該規格對應的磁碟大小。 |
| specGroupType | String | local_efficiency | 儲存類型，支援以下三種類型：
|
| enable | Boolean | true | 是否支援購買：
|
| 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 | 磁碟儲存類型。 返回以下三種類型：
|
| supportVersions | Array of CategoryEntity | 支援的版本配置。 |
|
| instanceCategory | String | x-pack | 執行個體類別，支援以下兩種類別：
|
| 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 | 開啟Jvm回收所需規格的記憶體最小值。 |
| 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 | 是否支援開啟磁碟加密：
|
| 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 | 彈性節點配置。 |
|
| diskList | Array of disk | 磁碟配置列表。 |
|
| scaleLimit | Integer | 2048 | 磁碟允許設定連續值的最大值。 |
| minSize | Integer | 500 | 磁碟允許的最小值。 |
| diskEncryption | Boolean | true | 是否支援開啟磁碟加密：
|
| 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 | 節點數最小值。 |
說明 以上的樣本值僅供參考，以介面實際傳回值為準。
樣本
請求樣本
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
}
}
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。