ModifyInstanceMaintainTime - 更改并开启实例的可维护时间-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

接口说明

调用此接口前，请注意：

在进行正式维护前，阿里云会给您阿里云账号中设置的联系人发送短信和邮件，请注意查收。
实例维护当天，为保障整个维护过程的稳定性，实例会在可维护时间段之前进入生效中的状态。当实例处于该状态时，对集群的访问以及查询类操作（如性能监控）不会受到影响，但相关集群变更操作（如集群升配、重启等）均暂时无法使用。
在可维护时间段内，实例连接可能发生闪断，请确保应用程序具有重连机制。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ModifyInstanceMaintainTime

update

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无

请求语法

POST /openapi/instances/{InstanceId}/actions/modify-maintaintime HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-n6w1o1x0w001c****

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5A2CFF0E-5718-45B5-9D4D-70B3FF****
body	string	否	请求体参数，详情请参见下文的 RequestBody 章节。	{ "openMaintainTime": true, "maintainStartTime": "03:00Z", "maintainEndTime": "04:00Z" }

RequestBody

RequestBody 中还需填入以下参数，用来指定可维护时间段信息。 | 名称 | 类型 | 是否必选 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | maintainStartTime| String | 否 | 02:00Z |可维护时间段的开始时间，格式：HH:mmZ（UTC 时间）。| | maintainEndTime| String | 否 | 06:00Z |可维护时间段的结束时间，格式：HH:mmZ（UTC 时间）。| | openMaintainTime| boolean | 是 | true |是否开启可维护时间段功能。仅支持 true，表示开启。|

示例如下。

{
    "openMaintainTime": true,
    "maintainStartTime": "03:00Z",
    "maintainEndTime": "04:00Z"
}

返回参数

名称	类型	描述	示例值
	object
Result	boolean	返回结果。	true
RequestId	string	请求 ID。	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

示例

正常返回示例

JSON格式

{
  "Result": true,
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****"
}

错误码

HTTP status code	错误码	错误信息
400	ComponentCodeValueError	component value is disable
401	UserNotOpen	Aliyun account is not open elasticsearch
401	StsRoleAccountNoPermission	Role account has no permission or expired
401	SubAccountNoPermission	Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401	UserUnauthorized	Authentication required

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

变更历史

更多信息，参考变更详情。