调用DescribeInstance,查询指定实例的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/instances/[InstanceId] HTTP/1.1

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String es-cn-s9dsk3k4k****

实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

当前请求的Request ID。

Result

当前实例的详细信息。

advancedDedicateMaster Boolean false

是否包含专有主节点。

clientNodeConfiguration

控制节点配置信息。

amount Integer 3

控制节点数量。

disk Integer 40

控制节点磁盘大小,单位为GB。

diskType String cloud_efficiency

控制节点磁盘类型,cloud_efficiency:高效云盘。

spec String elasticsearch.n4.small

控制节点规格。

createdAt String 2018-07-13T03:58:07.253Z

实例创建时间。

dedicateMaster Boolean false

是否包含专有主节点(旧版本)。

description String es-cn-abc

实例名称。

dictList Array

IK词典配置。

fileSize Long 2782602

IK词典文件大小,单位:字节。

name String SYSTEM_MAIN.dic

IK词典文件名称。

sourceType String ORIGIN

来源类型。

type String MAIN

IK词典类型。可选值:MAIN(主分词)、STOP(停用词)。

domain String es-cn-abc.elasticsearch.aliyuncs.com

实例分配的私网域名。

enableKibanaPublicNetwork Boolean true

Kibana是否开启公网访问。

enablePublic Boolean true

是否开启公网访问。

esConfig Map {"http.cors.allow-credentials":"false"}

ES实例的yml文件配置信息。

esIPBlacklist List [ "0.0.0.0/0" ]

ES私网黑名单(已废弃)。

esIPWhitelist List [ "0.0.0.0/0" ]

ES私网白名单(已废弃)。

esVersion String 5.5.3_with_X-Pack

实例版本。

haveClientNode Boolean true

是否包含协调节点。

haveKibana Boolean true

是否包含Kibana节点。

instanceId String es-cn-abc

实例 ID

kibanaConfiguration

Kibana节点的配置信息。

amount Integer 1

Kibana节点数量。

disk Integer 40

Kibana节点的磁盘大小,单位为GB。

diskType String cloud_ssd

Kibana节点磁盘类型(忽略)。

spec String elasticsearch.n4.small

Kibana节点规格。

kibanaDomain String es-cn-abc.kibana.elasticsearch.aliyuncs.com

Kibana地址。

kibanaIPWhitelist List [ "0.0.0.0/0" ]

Kibana私网白名单。

kibanaPort Integer 5601

Kibana节点分配的端口。

masterConfiguration

Master节点配置。

amount Integer 3

Master节点数量。

disk Integer 40

Master节点磁盘大小,单位为GB。

diskType String cloud_ssd

Master节点的类型,cloud_ssd:SSD云盘。

spec String elasticsearch.n4.small

Master节点的规格。

networkConfig

网络配置。

type String vpc

网络类型,目前只支持VPC网络。

vpcId String vpc-abc

VPC网络ID。

vsArea String cn-hangzhou-b

实例所在的可用区。

vswitchId String vsw-abc

交换机ID。

nodeAmount Integer 2

实例的节点个数。

nodeSpec

节点配置信息。

disk Integer 40

节点磁盘大小,单位:GB。

diskType String cloud_ssd

节点磁盘类型,cloud_ssd表示SSD云盘。

spec String elasticsearch.n4.small

节点规格。

paymentType String postpaid

实例的付费方式。可选值:prepaid(包年包月)和postpaid(按量付费)。

port Integer 9200

实例分配端口。

privateNetworkIpWhiteList List 0.0.0.0/0

私网白名单。

protocol String HTTP

访问协议。可选值:HTTPHTTPS

publicDomain String es-cn-abc.elasticsearch.aliyuncs.com

当前实例的公网地址。

publicIpWhitelist List [ "0.0.0.0/0" ]

公网地址访问白名单列表。

publicPort Integer 8033

公网端口。

status String active

实例的状态。可选值:active(正常)、activating(生效中)、inactive(冻结)和invalid(失效)。

synonymsDicts Array

同义词词典配置。

fileSize Long 2782602

同义词词典大小,单位:字节。

name String SYSTEM_MAIN.dic

同义词词典文件名称。

sourceType String ORIGIN

来源类型。

type String STOP

词典类型。取值:MAIN(主分词)、STOP(停用词)。

updatedAt String 2018-07-13T03:58:07.253Z

实例最后更新时间。

vpcInstanceId String vpc-bp1uag5jj38c****

VPC实例ID。

warmNode Boolean true

是否有warm节点。

warmNodeConfiguration

warm节点配置信息。

amount Integer 6

warm节点数量。

disk Integer 500

warm节点磁盘大小,单位:GB。

diskType String cloud_efficiency

warm节点磁盘类型,cloud_efficiency表示高效云盘。

spec String elasticsearch.n4.small

warm节点规格。

zoneCount Integer 2

实例的可用区个数。

zoneInfos Array

可用区信息。

status String NORMAL

可用区状态。可选值:ISOLATION(下线)、NORMAL(正常)。

zoneId String cn-hangzhou-b

可用区ID。

示例

请求示例

GET /openapi/instances/[InstanceId] HTTP/1.1
公共请求头
{
  "InstanceId": "es-cn-s9dsk3k4k****"
}

正常返回示例

XML 格式

<Result>
    <instanceId>es-cn-pp7055iz678v1****</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>es-cn-pp7055iz678v1****</description>
    <nodeAmount>2</nodeAmount>
    <paymentType>postpaid</paymentType>
    <paymentInfo/>
    <status>active</status>
    <port>9200</port>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <esConfig>
        <action.destructive_requires_name>true</action.destructive_requires_name>
        <xpack.security.audit.outputs>logfile</xpack.security.audit.outputs>
        <xpack.watcher.enabled>false</xpack.watcher.enabled>
        <action.auto_create_index>+.*,-*</action.auto_create_index>
    </esConfig>
    <kibanaDomain>es-cn-abc.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <publicDomain/>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.n4.small</spec>
        <disk>20</disk>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-abc</vpcId>
        <vswitchId>vsw-abc</vswitchId>
        <vsArea>cn-hangzhou-b</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2018-07-17T18:19:02.019Z</createdAt>
    <updatedAt>2018-07-18T16:10:05.147Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687603200000</endTime>
</Result>
<RequestId>B0BB1C4B-AF9C-465D-BED4-9E4C5B54****</RequestId>

JSON 格式

{
	"Result":{
		"port":9200,
		"nodeAmount":2,
		"kibanaIPWhitelist":[],
		"esVersion":"5.5.3_with_X-Pack",
		"enablePublic":false,
		"endTime":4687603200000,
		"nodeSpec":{
			"spec":"elasticsearch.n4.small",
			"disk":20
		},
		"inited":true,
		"description":"es-cn-pp7055iz678v1****",
		"kibanaDomain":"es-cn-abc.kibana.elasticsearch.aliyuncs.com",
		"createdAt":"2018-07-17T18:19:02.019Z",
		"dictList":[],
		"domain":"es-cn-abc.elasticsearch.aliyuncs.com",
		"dedicateMaster":false,
		"publicIpWhitelist":[],
		"esConfig":{
			"xpack.watcher.enabled":"false",
			"action.destructive_requires_name":"true",
			"xpack.security.audit.outputs":"logfile",
			"action.auto_create_index":"+.*,-*"
		},
		"status":"active",
		"paymentType":"postpaid",
		"instanceId":"es-cn-pp7055iz678v1****",
		"esIPWhitelist":[],
		"updatedAt":"2018-07-18T16:10:05.147Z",
		"esIPBlacklist":[],
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"commodityCode":"elasticsearch"
	},
	"RequestId":"B0BB1C4B-AF9C-465D-BED4-9E4C5B54****"
}

错误码

HttpCode 错误码 错误信息 描述
400 InstanceNotFound The instanceId provided does not exist 实例找不到,请核对实例状态

访问错误中心查看更多错误码。