获取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 | 实例版本类型。可选值：
|
返回数据
以下返回示例中，包含响应返回中的大部分参数，具体以实际返回为准，程序中不建议强制依赖获取以上参数。
示例
请求示例
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"
}
} ]
}错误码
访问错误中心查看更多错误码。
该文章对您有帮助吗？
- 本页导读 （1）
- 调试
- 请求头
- 请求语法
- 请求参数
- 返回数据
- 示例
- 错误码
