查看应用维护

该接口用于根据维护计划的 app key 查询具体的维护窗口详情。

---

示例

请求URl（GET）

curl --location 'https://caweb.aiops.com/api/alert/rest/api/v1/maintenance/appKey' \ 
--user 'email@example.com:<access_token>' \
--header 'Accept: application/json'

参数	类型	说明
appKey	string	必填，设置了维护计划的APP对应的唯一标识

access_token如何获取请参考文档 api令牌

提示

• appkey请替换成系统中真实接入生成的appkey的值

• 示例邮箱应替换为用户注册所用邮箱

• access_token应替换为您手动获取的access_token

• 如需对请求进行加密处理：请将
--user 'email@example.com:access_token' \

--header 'Accept: application/json'

替换为：

--header 'Authorization: Basic Z2FveWluaW5nOTk5NUAxNjMuY29tOmt1WWl6bmljZ3oxN0JBVjk=' \

--header 'Content-Type: application/json'

• 替换步骤请参考加密步骤

响应报文

{ 
    "result": "success", 
    "message": "ok", 
    "data": { 
        "id": "483eaf3b-4c3c-44ce-9f55-d72ad2d27da7", 
        "entityId": "299cece4a8164d28b9f7e22e44c6e7c3", 
        "timeZone": "BeiJingDong8", 
        "startTime": 1735104792944, 
        "endTime": 1735106592944, 
        "owner": "768215042", 
        "description": "", 
        "status": "ACTIVE", 
        "deleted": 0, 
        "comments": "", 
        "cancled": 0, 
        "dataMaskType": 0, 
        "ruleMaskId": null, 
        "cycle": 0, 
        "cycleTime": null, 
        "isReceiveData": 0, 
        "modifiedTime": "2024-12-25 14:03", 
        "creationTime": "2024-12-25 13:33" 
        }, 
        "totalCount": 1, 
        "code": 200 
}

响应参数

字段名	类型	说明
result	string	请求结果，可能值：success 或 failed
message	string	请求状态描述
data		维护窗口的详细信息。没有维护计划为null
totalCount	int	回的记录总数（通常为 1）
code	int	HTTP 状态码（成功为 200）

data结果集

参数	类型	说明
id	string	维护计划的ID
entityId	string	查询时使用的 appkey。
timeZone	string	时区信息，例如 BeiJingDong8
startTime	Number	维护窗口的开始时间（时间戳，毫秒）
endTime	Number	维护窗口的结束时间（时间戳，毫秒）
owner	string	创建该维护窗口的用户 ID
description	string	维护窗口的描述信息
status	string	维护窗口状态，例如 ACTIVE（激活）
deleted	Number	是否已删除，0 表示未删除
comments	string	备注信息
cancled	Number	是否已取消，0 表示未取消
dataMaskType	Number	数据屏蔽类型，通常为 0
ruleMaskId	string	数据屏蔽规则（如果有）
cycle	Number	是否循环，0 表示不循环
cycleTime	string	循环时间（如果有）
isReceiveData	Number	是否接收数据，0 表示不接收
modifiedTime	string	上次修改时间，格式为 yyyy-MM-dd HH:mm
creationTime	string	创建时间，格式为 yyyy-MM-dd HH:mm

错误响应

{ 
    "result": "failed", 
    "message": "失败，请检查参数.", 
    "data": null, 
    "totalCount": 0, 
    "code": 400 
}

错误响应码

错误码	说明
200	成功
400	失败，传入的参数有问题
401	认证失败，用户名密码错误
403	权限失败，用户没有权限做此操作