You need to enable JavaScript to run this app.
导航
ModifyMaintenanceSetting - ModifyMaintenanceSetting - 修改维护时间
最近更新时间:2024.10.21 17:11:14首次发布时间:2023.11.30 14:19:27

调用 ModifyMaintenanceSetting 接口,修改实例的可维护时间

背景信息

为提高实例的稳定性,后端系统会不定期对实例进行维护,系统默认的维护时间是每日的 02:00~06:00。您可以根据业务规律,将可维护时间段设置在业务低峰期,以降低维护过程中对业务造成的影响。

在每个特定日期的维护时间段,平台的运维人员可能会对您的实例进行必要的维护工作。您配置的维护时间段代表您对这个日期中维护时间段内可能发生的集群升级和维护已经有预期,并能够做出必要的准备。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ModifyMaintenanceSetting

要执行的操作,取值:ModifyMaintenanceSetting。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-00k***o718

需要设置可维护时间段的实例 ID。

MaintenanceDay
Array of String

[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]

一周内允许平台进行维护的日期列表。

MaintenanceTime
String

02:00-04:00

在一天内允许平台进行维护的 UTC 时间段。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Status
String

SUCCESSFUL

返回的操作状态。

Message
String

-

返回的提示信息。

请求示例

POST https://open.volcengineapi.com/?Action=ModifyMaintenanceSetting&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceId": "o-00k***o718",
    "MaintenanceTime": "02:00-04:00",
    "MaintenanceDay": [
        "MONDAY",
        "TUESDAY"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ModifyMaintenanceSetting",
        "Region": "cn-beijing",
        "RequestId": "202306041104200100100232280***",
        "Service": "ESCloud",
        "Version": "2023-01-01"
    },
    "Result": {
        "Message": "",
        "Status": "SUCCESSFUL"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
InternalServerError
服务器内部异常

服务由于异常退出,无法完成接口请求操作

200
IllegalParameter
illegal parameter

非法参数。可能是参数缺失,也可能是参数不符合接口要求

200
Unauthorized
unauthorized error

用户无权限调用接口