獲取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 | 實例所在的可用區(qū)ID。 |
paymentType | String | Query | 否 | postpaid | 實例的付費類型??蛇x值:
|
instanceCategory | String | Query | 否 | advanced | 實例版本類型??蛇x值:
|
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請求ID。 |
Headers | Object | 返回頭信息。 |
|
X-Total-Count | Integer | 10 | 實例總記錄數。 |
Result | Array of Instance | 返回結果。 |
|
advancedDedicateMaster | Boolean | false | 是否包含專有主節(jié)點,取值含義如下:
|
nodeAmount | Integer | 2 | 實例的數據節(jié)點數量。 |
createdAt | String | 2018-07-13T03:58:07.253Z | 實例創(chuàng)建時間。 |
status | String | active | 實例的狀態(tài),取值含義如下:
|
dedicateMaster | Boolean | false | 是否包含專有主節(jié)點(已廢棄),取值含義如下:
|
serviceVpc | Boolean | true | 是否為服務VPC。 |
paymentType | String | postpaid | 實例的付費方式。支持:
|
resourceGroupId | String | rg-aekzvowej3i**** | 資源組ID。 |
postpaidServiceStatus | String | active | 預付費實例疊加的后付費服務狀態(tài)。支持:
|
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 | 協(xié)調節(jié)點配置。 |
|
spec | String | elasticsearch.sn2ne.large | 節(jié)點規(guī)格。規(guī)格信息可通過產品規(guī)格查看。 |
amount | Integer | 3 | 節(jié)點數量。 |
disk | Integer | 20 | 節(jié)點存儲空間大小,單位為GB。 |
diskType | String | cloud_efficiency | 節(jié)點的存儲類型,只支持高效云盤(cloud_efficiency)。 |
specInfo | String | 1C 2G | 節(jié)點規(guī)格描述。 |
elasticDataNodeConfiguration | Object | 彈性數據節(jié)點配置。 |
|
spec | String | elasticsearch.sn2ne.large | 節(jié)點規(guī)格。規(guī)格信息可通過產品規(guī)格查看。 |
amount | Integer | 3 | 節(jié)點數量。 |
disk | Integer | 20 | 節(jié)點存儲空間大小,單位為GB。 |
diskEncryption | Boolean | true | 是否為節(jié)點開啟云盤加密,取值含義如下:
|
diskType | String | cloud_ssd | 節(jié)點存儲類型。支持:
|
specInfo | String | 1C 2G | 節(jié)點規(guī)格描述 |
kibanaConfiguration | Object | Kibana節(jié)點配置。 |
|
spec | String | elasticsearch.n4.small | 節(jié)點規(guī)格。規(guī)格信息可通過產品規(guī)格查看。 |
amount | Integer | 1 | 節(jié)點數量。 |
disk | Integer | 20 | 節(jié)點存儲空間大小,單位為GB。 |
diskType | String | cloud_ssd | 節(jié)點存儲類型。 |
specInfo | String | 1C 2G | 節(jié)點規(guī)格描述 |
masterConfiguration | Object | Master節(jié)點配置。 |
|
spec | String | elasticsearch.sn2ne.large | 節(jié)點規(guī)格。規(guī)格信息可通過產品規(guī)格查看。 |
amount | Integer | 3 | 節(jié)點數量。 |
disk | Integer | 20 | 節(jié)點存儲空間大小,單位為GB。 |
diskType | String | cloud_ssd | 節(jié)點存儲類型。只支持cloud_ssd(SSD云盤)。 |
specInfo | String | 1C 2G | 節(jié)點規(guī)格描述 |
networkConfig | Object | 網絡配置。 |
|
vpcId | String | vpc-abc | 專有網絡ID。 |
vsArea | String | cn-hangzhou-e | 實例所在的可用區(qū)。 |
type | String | vpc | 網絡類型,只支持專有網絡VPC(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 | 數據節(jié)點配置信息。 |
|
spec | String | elasticsearch.n4.small | 節(jié)點規(guī)格。規(guī)格信息可通過產品規(guī)格查看。 |
disk | Integer | 50 | 節(jié)點的存儲空間大小,單位為GB。 |
diskEncryption | Boolean | false | 是否使用磁盤加密,取值含義如下:
|
diskType | String | cloud_ssd | 節(jié)點的存儲類型。支持:
|
performanceLevel | String | PL1 | ESSD云盤的性能級別。當diskType為cloud_essd時,該參數必選,支持PL1、PL2、PL3。 |
specInfo | String | 1C 2G | 節(jié)點規(guī)格描述 |
vpcInstanceId | String | vpc-bp1uag5jj38c**** | 專有網絡ID。 |
kibanaIPWhitelist | Array of String | "0.0.0.0/0" | 集群Kibana節(jié)點公網訪問白名單。 |
kibanaPrivateIPWhitelist | Array of String | ["192.168.XX.XX"] | 集群Kibana節(jié)點私網訪問白名單。 |
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:云原生新管控 |
示例
請求示例
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"
}
} ]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。