调用UpdateInstanceSettings,更新指定阿里云Elasticsearch实例yml参数的设置。

注意 调用该接口时,实例状态为生效中(activating)、失效(invalid)和冻结(inactive)时,无法更新信息。

调试

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

请求头

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

请求语法

POST /openapi/instances/[InstanceId]/instance-settings HTTP/1.1

请求参数

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

实例ID。

clientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不值过64个ASCII字符。

需要填写body请求参数,详情请参见请求示例

返回数据

名称 类型 示例值 描述
RequestId String BB1C321A-211C-4FD7-BD8B-7F2FABE2****

当前请求的Request ID。

示例

请求示例

POST /openapi/instances/[InstanceId]/instance-settings HTTP/1.1
公共请求头
{
  "InstanceId": "es-cn-abc"
}

请求示例补充说明

 body请求示例:
{
  "esConfig": {
    "thread_pool.bulk.queue_size": 500
  }
}

正常返回示例

XML 格式

<RequestId>9FCBC546-3868-44B8-A102-5493C8C5****</RequestId>
<Result>
    <commodityCode>elasticsearch</commodityCode>
    <createdAt>2018-07-20T06:20:18.665Z</createdAt>
    <dedicateMaster>false</dedicateMaster>
    <description>test</description>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <enablePublic>false</enablePublic>
    <endTime>4687776000000</endTime>
    <esConfig>
        <action.auto_create_index>+.*,-*</action.auto_create_index>
        <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>
    </esConfig>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <inited>true</inited>
    <instanceId>es-cn-abc</instanceId>
    <kibanaDomain>es-cn-abc.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <networkConfig>
        <type>vpc</type>
        <vpcId>vpc-abc</vpcId>
        <vsArea>cn-hangzhou-b</vsArea>
        <vswitchId>vsw-abc</vswitchId>
    </networkConfig>
    <nodeAmount>2</nodeAmount>
    <nodeSpec>
        <disk>40</disk>
        <spec>elasticsearch.n4.small</spec>
    </nodeSpec>
    <paymentType>postpaid</paymentType>
    <port>9200</port>
    <status>active</status>
    <updatedAt>2018-07-20T06:37:29.266Z</updatedAt>
</Result>

JSON 格式

{
	"Result":{
		"port":9200,
		"publicIpWhitelist":[],
		"esConfig":{
			"xpack.watcher.enabled":"false",
			"action.destructive_requires_name":"true",
			"xpack.security.audit.outputs":"logfile",
			"action.auto_create_index":"+.*,-*"
		},
		"nodeAmount":2,
		"status":"active",
		"kibanaIPWhitelist":[],
		"paymentType":"postpaid",
		"instanceId":"es-cn-abc",
		"esIPWhitelist":[],
		"esVersion":"5.5.3_with_X-Pack",
		"enablePublic":false,
		"endTime":4687776000000,
		"nodeSpec":{
			"spec":"elasticsearch.n4.small",
			"disk":40
		},
		"updatedAt":"2018-07-20T06:37:29.266Z",
		"inited":true,
		"esIPBlacklist":[],
		"kibanaDomain":"es-cn-abc.kibana.elasticsearch.aliyuncs.com",
		"createdAt":"2018-07-20T06:20:18.665Z",
		"description":"test",
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"dictList":[],
		"domain":"es-cn-abc.elasticsearch.aliyuncs.com",
		"dedicateMaster":false,
		"commodityCode":"elasticsearch"
	},
	"RequestId":"9FCBC546-3868-44B8-A102-5493C8C5****"
}

错误码

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