擷取ES執行個體列表資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。
請求文法
GET /openapi/instances HTTP/1.1請求參數
|
名稱 |
類型 |
位置 |
是否必選 |
樣本值 |
描述 |
| page | Integer | Query | 否 | 1 | 執行個體列表的頁碼。 起始值：1，預設值：1。 |
| size | Integer | Query | 否 | 10 | 分頁查詢時設定的每頁條數。最大值：100，預設值：10。 |
| description | String | Query | 否 | aliyunes_test1 | 執行個體名稱，支援模糊查詢。例如搜尋abc的所有執行個體，則可能返回abc、abcde、xyabc、xabcy的所有執行個體。 |
| instanceId | String | Query | 否 | es-cn-v641a0ta3000g**** | 執行個體ID。 |
| esVersion | String | Query | 否 | 6.7_with_X-Pack | 執行個體版本。 |
| resourceGroupId | String | Query | 否 | rg-aekzvowej3i**** | 執行個體所在的資源群組ID。 |
| tags | String | Query | 否 | [{"tagKey":"key1","tagValue":"value1"}] | 執行個體標籤。 |
| vpcId | String | Query | 否 | vpc-bp16k1dvzxtmagcva**** | 執行個體所在的專用網路ID。 |
| zoneId | String | Query | 否 | cn-hangzhou-i | 執行個體所在的可用性區域ID。 |
| paymentType | String | Query | 否 | postpaid | 執行個體的付費類型。可選值：
|
| instanceCategory | String | Query | 否 | advanced | 執行個體版本類型。可選值：
|
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請求ID。 |
| Headers | Object | 返回頭資訊。 |
|
| X-Total-Count | Integer | 10 | 執行個體總記錄數。 |
| Result | Array of Instance | 返回結果。 |
|
| advancedDedicateMaster | Boolean | false | 是否包含專有主節點，取值含義如下：
|
| nodeAmount | Integer | 2 | 執行個體的資料節點數量。 |
| createdAt | String | 2018-07-13T03:58:07.253Z | 執行個體建立時間。 |
| status | String | active | 執行個體的狀態，取值含義如下：
|
| dedicateMaster | Boolean | false | 是否包含專有主節點（已廢棄），取值含義如下：
|
| serviceVpc | Boolean | true | 是否為服務VPC。 |
| paymentType | String | postpaid | 執行個體的付費方式。支援：
|
| resourceGroupId | String | rg-aekzvowej3i**** | 資源群組ID。 |
| postpaidServiceStatus | String | active | 預付費執行個體疊加的後付費服務狀態。支援：
|
| description | String | es-cn-abc | 執行個體名稱。 |
| esVersion | String | 6.7_with_X-Pack | 執行個體版本。 |
| isNewDeployment | String | true | 是否為新部署架構。 |
| updatedAt | String | 2018-07-18T10:10:04.484Z | 執行個體最後更新的時間。 |
| instanceId | String | es-cn-v641a0ta3000g**** | 執行個體ID。 |
| tags | Array of Tag | 執行個體標籤。 |
|
| tagKey | String | env | 標籤鍵。 |
| tagValue | String | dev | 標籤值。 |
| extendConfigs | Array of Object | [{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }] | 叢集擴充參數配置。 |
| clientNodeConfiguration | Object | 協調節點配置。 |
|
| spec | String | elasticsearch.sn2ne.large | 節點規格。規格資訊可通過產品規格查看。 |
| amount | Integer | 3 | 節點數量。 |
| disk | Integer | 20 | 節點儲存空間大小，單位為GB。 |
| diskType | String | cloud_efficiency | 節點的儲存類型，只支援高效雲端硬碟（cloud_efficiency）。 |
| specInfo | String | 1C 2G | 節點規格描述。 |
| elasticDataNodeConfiguration | Object | 彈性資料節點配置。 |
|
| spec | String | elasticsearch.sn2ne.large | 節點規格。規格資訊可通過產品規格查看。 |
| amount | Integer | 3 | 節點數量。 |
| disk | Integer | 20 | 節點儲存空間大小，單位為GB。 |
| diskEncryption | Boolean | true | 是否為節點開啟雲端硬碟加密，取值含義如下：
|
| diskType | String | cloud_ssd | 節點儲存類型。支援：
|
| specInfo | String | 1C 2G | 節點規格描述 |
| kibanaConfiguration | Object | Kibana節點配置。 |
|
| spec | String | elasticsearch.n4.small | 節點規格。規格資訊可通過產品規格查看。 |
| amount | Integer | 1 | 節點數量。 |
| disk | Integer | 20 | 節點儲存空間大小，單位為GB。 |
| diskType | String | cloud_ssd | 節點儲存類型。 |
| specInfo | String | 1C 2G | 節點規格描述 |
| masterConfiguration | Object | Master節點配置。 |
|
| spec | String | elasticsearch.sn2ne.large | 節點規格。規格資訊可通過產品規格查看。 |
| amount | Integer | 3 | 節點數量。 |
| disk | Integer | 20 | 節點儲存空間大小，單位為GB。 |
| diskType | String | cloud_ssd | 節點儲存類型。只支援cloud_ssd（SSD雲端硬碟）。 |
| specInfo | String | 1C 2G | 節點規格描述 |
| networkConfig | Object | 網路設定。 |
|
| vpcId | String | vpc-abc | 專用網路ID。 |
| vsArea | String | cn-hangzhou-e | 執行個體所在的可用性區域。 |
| type | String | vpc | 網路類型，只支援Virtual Private Cloud（Virtual Private Cloud）。 |
| vswitchId | String | vsw-def | 虛擬交換器ID。 |
| whiteIpGroupList | Array of whiteIpGroupList | 叢集公私網網路白名單分組設定。 |
|
| groupName | String | default | 分組名。 |
| whiteIpType | String | PUBLIC_KIBANA | 網路類型。PRIVATE_ES，ES私網。PUBLIC_KIBANA。Kibana公網。PUBLIC_ES，ES公網。PRIVATE_KIBANA，Kibana私網。 |
| ips | Array of String | ["0.0.0.0", "127.0.XX.XX"] | 網路白名單列表。 |
| nodeSpec | Object | 資料節點配置資訊。 |
|
| spec | String | elasticsearch.n4.small | 節點規格。規格資訊可通過產品規格查看。 |
| disk | Integer | 50 | 節點的儲存空間大小，單位為GB。 |
| diskEncryption | Boolean | false | 是否使用磁碟加密，取值含義如下：
|
| diskType | String | cloud_ssd | 節點的儲存類型。支援：
|
| performanceLevel | String | PL1 | ESSD雲端硬碟的效能層級。當diskType為cloud_essd時，該參數必選，支援PL1、PL2、PL3。 |
| specInfo | String | 1C 2G | 節點規格描述 |
| vpcInstanceId | String | vpc-bp1uag5jj38c**** | 專用網路ID。 |
| kibanaIPWhitelist | Array of String | "0.0.0.0/0" | 叢集Kibana節點公網訪問白名單。 |
| kibanaPrivateIPWhitelist | Array of String | ["192.168.XX.XX"] | 叢集Kibana節點私網訪問白名單。 |
| publicIpWhitelist | Array of String | [ "0.0.0.0/0" ] | Elasticsearch叢集公網訪問白名單。 |
| privateNetworkIpWhiteList | Array of String | ["192.168.XX.XX/25"] | Elasticsearch叢集私網訪問白名單。 |
| endTime | Long | 1715826092044 | 執行個體到期時間。 |
| archType | String | public | 部署模式，架構類型： exclusive：基礎管控 public：雲原生新管控 |
| domain | String | es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com | 執行個體的內網地址。 |
說明 以下返回樣本中，包含響應返回中的大部分參數，具體以實際返回為準，程式中不建議強制依賴擷取以上參數。
樣本
請求樣本
GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json正常返回樣本
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : [ {
"instanceId" : "es-cn-v641a0ta3000g****",
"description" : "aliyunes_test1",
"nodeAmount" : 3,
"paymentType" : "postpaid",
"status" : "active",
"esVersion" : "6.7.0_with_X-Pack",
"esConfig" : { },
"esIPWhitelist" : [ ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ ],
"kibanaIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"serviceVpc" : true,
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn1ne.large",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : true
},
"networkConfig" : {
"vpcId" : "vpc-bp1xk0naij7jx4ph1****",
"vswitchId" : "vsw-bp1ogpdintii5qvyx****",
"vsArea" : "cn-hangzhou-g",
"type" : "vpc"
},
"createdAt" : "2019-08-26T08:18:06.652Z",
"updatedAt" : "2019-08-26T08:19:49.448Z",
"inited" : true,
"tags" : [ {
"tagKey" : "key1",
"tagValue" : "value1"
} ],
"dedicateMaster" : false,
"advancedDedicateMaster" : true,
"masterConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 3,
"diskType" : "cloud_ssd",
"disk" : 20
},
"haveClientNode" : true,
"warmNode" : true,
"warmNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 500,
"diskEncryption" : true
},
"clientNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 20
},
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"commodityCode" : "elasticsearch",
"endTime" : 4722508800000,
"dictList" : [ ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"resourceGroupId" : "rg-acfmwriiikz****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-g",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : false,
"advancedSetting" : {
"gcName" : "CMS"
}
}, {
"instanceId" : "es-cn-v641920bh0006****",
"description" : "aliyunes_test2",
"nodeAmount" : 2,
"paymentType" : "postpaid",
"status" : "active",
"esVersion" : "6.7.0_with_X-Pack",
"archType" : "exclusive",
"esConfig" : { },
"esIPWhitelist" : [ ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ ],
"kibanaIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn2ne.2xlarge",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : false
},
"networkConfig" : {
"vpcId" : "vpc-bp1op7luys63go2x5****",
"vswitchId" : "vsw-bp1rusvg785q97ucp****",
"vsArea" : "cn-hangzhou-i",
"type" : "vpc"
},
"createdAt" : "2019-08-07T13:14:07.974Z",
"updatedAt" : "2019-08-12T03:04:27.215Z",
"inited" : true,
"tags" : [ ],
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : false,
"warmNode" : false,
"warmNodeConfiguration" : { },
"clientNodeConfiguration" : { },
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"commodityCode" : "elasticsearch",
"endTime" : 4720867200000,
"dictList" : [ ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"resourceGroupId" : "rg-acfmwriiikz****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-i",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : false,
"advancedSetting" : {
"gcName" : "CMS"
}
} ]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。