ListInstance

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

GET /openapi/instances HTTP/1.1

Request parameters

Response parameters

Examples

Sample requests

GET /openapi/instances? description=abc&page=1&size=10

Sample success responses

XML format

<Result>
    <instanceId>es-cn-abc</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>es-cn-abc</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-18T10:10:04.484Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687603200000</endTime>
</Result>
<Result>
    <instanceId>es-cn-def</instanceId>
    <domain>es-cn-def.elasticsearch.aliyuncs.com</domain>
    <description>keepit</description>
    <nodeAmount>3</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-def.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <publicDomain/>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.sn1ne.large</spec>
        <disk>20</disk>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-def</vpcId>
        <vswitchId>vsw-def</vswitchId>
        <vsArea>cn-hangzhou-b</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2018-07-13T03:58:07.253Z</createdAt>
    <updatedAt>2018-07-18T10:10:15.259Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>true</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687171200000</endTime>
</Result>
<RequestId>E2BAE51F-48A8-44D2-B5CD-A3BCE6B8****</RequestId>
<Headers>
    <X-Total-Count>2</X-Total-Count>
</Headers>

JSON format

{
	"Headers":{
		"X-Total-Count":2
	},
	"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-abc",
			"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-abc",
			"esIPWhitelist":[],
			"updatedAt":"2018-07-18T10:10:04.484Z",
			"esIPBlacklist":[],
			"networkConfig":{
				"vpcId":"vpc-abc",
				"vswitchId":"vsw-abc",
				"vsArea":"cn-hangzhou-b",
				"type":"vpc"
			},
			"commodityCode":"elasticsearch"
		},
		{
			"port":9200,
			"nodeAmount":3,
			"kibanaIPWhitelist":[],
			"esVersion":"5.5.3_with_X-Pack",
			"enablePublic":false,
			"endTime":4687171200000,
			"nodeSpec":{
				"spec":"elasticsearch.sn1ne.large",
				"disk":20
			},
			"inited":true,
			"description":"keepit",
			"kibanaDomain":"es-cn-def.kibana.elasticsearch.aliyuncs.com",
			"createdAt":"2018-07-13T03:58:07.253Z",
			"dictList":[],
			"domain":"es-cn-def.elasticsearch.aliyuncs.com",
			"dedicateMaster":true,
			"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-def",
			"esIPWhitelist":[],
			"updatedAt":"2018-07-18T10:10:15.259Z",
			"esIPBlacklist":[],
			"networkConfig":{
				"vpcId":"vpc-def",
				"vswitchId":"vsw-def",
				"vsArea":"cn-hangzhou-b",
				"type":"vpc"
			},
			"commodityCode":"elasticsearch"
		}
	],
	"RequestId":"E2BAE51F-48A8-44D2-B5CD-A3BCE6B8****"
}

Error codes

For a list of error codes, visit the API Error Center.