文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 其他接口/ 查询维护时间窗时间段
更新时间：2024-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询维护时间窗时间段

功能介绍

查询维护时间窗开始时间和结束时间。

调用方法

请参见如何调用API。

URI

GET /v2/instances/maintain-windows

请求参数

无

响应参数

状态码： 200

表1 响应Body参数

参数

参数类型

描述

maintain_windows

Array of MaintainWindowsEntity objects

参数解释：

支持的维护时间窗列表。

取值范围：

不涉及。
表2 MaintainWindowsEntity

参数

参数类型

描述

seq

Integer

参数解释：

序号。

取值范围：

不涉及。

default

Boolean

参数解释：

是否为默认时间段。

取值范围：

  • true

  • false

begin

String

参数解释：

维护时间窗开始时间，时间为UTC时间，格式为HH:mm:ss。

取值范围：

不涉及。

end

String

参数解释：

维护时间窗结束时间，时间为UTC时间，格式为HH:mm:ss。

取值范围：

不涉及。

状态码： 500

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/instances/maintain-windows

响应示例

状态码： 200

查询维护时间窗时间段成功。

{
  "maintain_windows" : [ {
    "default" : true,
    "end" : "19",
    "begin" : "18",
    "seq" : 1
  }, {
    "default" : false,
    "end" : "20",
    "begin" : "19",
    "seq" : 2
  }, {
    "default" : false,
    "end" : "21",
    "begin" : "20",
    "seq" : 3
  }, {
    "default" : false,
    "end" : "22",
    "begin" : "21",
    "seq" : 4
  }, {
    "default" : false,
    "end" : "23",
    "begin" : "22",
    "seq" : 5
  }, {
    "default" : false,
    "end" : "00",
    "begin" : "23",
    "seq" : 6
  }, {
    "default" : false,
    "end" : "01",
    "begin" : "00",
    "seq" : 1
  }, {
    "default" : false,
    "end" : "02",
    "begin" : "01",
    "seq" : 2
  }, {
    "default" : false,
    "end" : "03",
    "begin" : "02",
    "seq" : 3
  }, {
    "default" : false,
    "end" : "04",
    "begin" : "03",
    "seq" : 3
  }, {
    "default" : false,
    "end" : "05",
    "begin" : "04",
    "seq" : 4
  }, {
    "default" : false,
    "end" : "06",
    "begin" : "05",
    "seq" : 5
  }, {
    "default" : false,
    "end" : "07",
    "begin" : "06",
    "seq" : 6
  }, {
    "default" : false,
    "end" : "08",
    "begin" : "07",
    "seq" : 1
  }, {
    "default" : true,
    "end" : "09",
    "begin" : "08",
    "seq" : 2
  }, {
    "default" : false,
    "end" : "10",
    "begin" : "09",
    "seq" : 3
  }, {
    "default" : false,
    "end" : "11",
    "begin" : "10",
    "seq" : 4
  }, {
    "default" : false,
    "end" : "12",
    "begin" : "11",
    "seq" : 5
  }, {
    "default" : false,
    "end" : "13",
    "begin" : "12",
    "seq" : 6
  }, {
    "default" : false,
    "end" : "14",
    "begin" : "13",
    "seq" : 1
  }, {
    "default" : true,
    "end" : "15",
    "begin" : "14",
    "seq" : 2
  }, {
    "default" : false,
    "end" : "16",
    "begin" : "15",
    "seq" : 3
  }, {
    "default" : false,
    "end" : "17",
    "begin" : "16",
    "seq" : 4
  }, {
    "default" : false,
    "end" : "18",
    "begin" : "17",
    "seq" : 5
  } ]
}

状态码

状态码

描述

200

查询维护时间窗时间段成功。

500

内部服务错误。

错误码

请参见错误码。

父主题： 其他接口

相关文档