调用RestartInstance,重启指定的阿里云Elasticsearch实例。

说明 重启后,Elasticsearch实例进入生效中(activing)状态。重启成功后,实例状态变为正常(active)。

调试

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

请求头

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

请求语法

POST /openapi/instances/[InstanceId]/actions/restart HTTP/1.1

请求参数

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

实例ID。

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

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

force Boolean false

是否忽略集群状态,强制重启。

返回数据

名称 类型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

当前请求的RequestID。

示例

请求示例

POST /openapi/instances/es-cn-abc/actions/restart?force=true&clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****

正常返回示例

XML 格式

<Result>
    <instanceId>es-cn-abc</instanceId>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <description>es-cn-abc</description>
    <nodeAmount>2</nodeAmount>
    <paymentType>prepaid</paymentType>
    <paymentInfo>
        <duration>1</duration>
        <pricingCycle>Month</pricingCycle>
        <isAutoRenew>false</isAutoRenew>
        <autoRenewDuration>0</autoRenewDuration>
    </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>true</action.auto_create_index>
    </esConfig>
    <kibanaDomain>es-cn-abc.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <publicDomain/>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.sn1ne.large</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-06-22T07:57:36.975Z</createdAt>
    <updatedAt>2018-06-22T07:57:36.975Z</updatedAt>
    <inited>true</inited>
    <dedicateMaster>false</dedicateMaster>
    <commodityCode>elasticsearchpre</commodityCode>
    <endTime>1532275200000</endTime>
</Result>
<RequestId>F99407AB-2FA9-489E-A259-40CF6DCC****</RequestId>

JSON 格式

{
	"Result":{
		"port":9200,
		"nodeAmount":2,
		"kibanaIPWhitelist":[],
		"esVersion":"5.5.3_with_X-Pack",
		"enablePublic":false,
		"endTime":1532275200000,
		"nodeSpec":{
			"spec":"elasticsearch.sn1ne.large",
			"disk":20
		},
		"inited":true,
		"description":"es-cn-abc",
		"kibanaDomain":"es-cn-abc.kibana.elasticsearch.aliyuncs.com",
		"createdAt":"2018-06-22T07:57:36.975Z",
		"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":"true"
		},
		"status":"active",
		"paymentType":"prepaid",
		"instanceId":"es-cn-abc",
		"esIPWhitelist":[],
		"updatedAt":"2018-06-22T07:57:36.975Z",
		"paymentInfo":{
			"duration":1,
			"isAutoRenew":false,
			"autoRenewDuration":0,
			"pricingCycle":"Month"
		},
		"esIPBlacklist":[],
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"commodityCode":"elasticsearchpre"
	},
	"RequestId":"F99407AB-2FA9-489E-A259-40CF6DCC****"
}

错误码

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