UpdateInstance

Before you call this operation, pay close attention to the following limits:

• When the instance is in the activating, invalid, or inactive state, you cannot modify its configuration.
• You can change only one instance property in each request. For example, you cannot send a request to change the instance specification and disk size at the same time.

Request header

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

Request syntax

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

Request parameters

You must specify request body parameters. For more information, see Sample requests.

Response parameters

Examples

Sample requests

PUT /openapi/instances/[InstanceId] HTTP/1.1
Common request header
{
  "InstanceId": "es-cn-xxx"
}

Request body

Sample request body:
{
  "nodeSpec": {
      "disk": 40
    }
}

Sample success responses

XML format

<Result>
    <instanceId>es-cn-abc</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>test</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>40</disk>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-abc</vpcId>
        <vswitchId>vsw-abc</vswitchId>
        <vsArea>cn-hangzhou-b</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2018-07-20T06:20:18.665Z</createdAt>
    <updatedAt>2018-07-20T06:37:29.266Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearch</commodityCode>
    <endTime>4687776000000</endTime>
</Result>
<RequestId>9FCBC546-3868-44B8-A102-5493C8C5****</RequestId>

JSON format

{
	"Result":{
		"port":9200,
		"nodeAmount":2,
		"kibanaIPWhitelist":[],
		"esVersion":"5.5.3_with_X-Pack",
		"enablePublic":false,
		"endTime":4687776000000,
		"nodeSpec":{
			"spec":"elasticsearch.n4.small",
			"disk":40
		},
		"inited":true,
		"description":"test",
		"kibanaDomain":"es-cn-abc.kibana.elasticsearch.aliyuncs.com",
		"createdAt":"2018-07-20T06:20:18.665Z",
		"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-20T06:37:29.266Z",
		"esIPBlacklist":[],
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"commodityCode":"elasticsearch"
	},
	"RequestId":"9FCBC546-3868-44B8-A102-5493C8C5****"
}

Error codes

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