ModifyInstanceMaintainTime_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

调用此接口前，请注意：

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:ModifyInstanceMaintainTime	Update	Instance acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}	无	无

请求语法

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

路径参数

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:es-cn-n6w1o1x0w001c****参考取值来源: ListInstance

请求参数

字段名称	字段详情
ClientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring	请求体参数，详情请参见下文的 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"
}

返回参数

字段名称	字段详情
Resultboolean	返回结果。示例值:true
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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	诊断

变更历史

暂无变更历史