自定义查岗规则服务-阿里云帮助中心

创建查岗规则

服务描述

调用该接口，创建查岗规则。

API定义

path	版本
/fire/zbb/duty/rule/create	0.0.2

请求参数

属性	类型	是否必填	说明
dutyName	String	是	规则名称，上限20字。
dutyTime	String	是	查岗规则cron表达式。
contentId	数组
	String	是	查岗内容id，最多支持5个contentId。
notifyUrl	数组	是	查岗结果通知类型和联系方式。
-type	String	是	查岗结果通知类型。 DING钉钉机器人 WEBHOOK通知。
-url	String	是	查岗结果通知联系方式。

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	JSON	不涉及。
-dutyId	String	查岗规则id。

请求示例

{
    "request":{
        "apiVer":"0.0.1"
    },
    "params":{
        "dutyName":"Q1查岗",
        "dutyTime":"0 0/30 9-17 * * ?",
        "contentId":[
            "1000002789",
            "1000002788"
        ],
        "notifyUrl":[
            {
                "type":"DING", 
                "url":"https://oapi.dingtalk.com/robot/send?access_token=6798602eefdee50d47ae09c94c98d57a4c8f69f03e984617efbd16f83328d748"
            }
        ]
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":{
        "dutyId":"d43471012885846d13babf1906430f2f"
    }
}

启用查岗规则

服务描述

调用该接口，启用创建的查岗规则。

API定义

path	版本
/fire/zbb/duty/rule/enable	0.0.1

请求参数

属性	类型	是否必填	说明
dutyId	String	是	查岗规则id。

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	Boolean	启用结果。

请求示例

{
    "request":{
        "apiVer":"0.0.1"
    },
    "params":{
            "dutyId":"d43471012885846d13babf1906430f2f"
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":true
}

停用用查岗规则

服务描述

调用该接口，停用创建的查岗规则

API定义

path	版本
/fire/zbb/duty/rule/disable	0.0.1

请求参数

属性	类型	是否必填	说明
dutyId	String	是	查岗规则id。

返回参数

属性	子属性	类型
code		int
message		String
localizedMsg		String
id		String
data		Boolean

请求示例

{
    "request":{
        "apiVer":"0.0.1"
    },
    "params":{
        "dutyId":"d43471012885846d13babf1906430f2f"
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":true
}

删除查岗规则

服务描述

调用该接口，删除创建的查岗规则。

API定义

path	版本
/fire/zbb/duty/rule/delete	0.0.1

请求参数

属性	类型	是否必填	说明
dutyId	String	是	查岗规则id。

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	Boolean	删除结果。

请求示例

{
    "request":{
    "apiVer":"0.0.1"
    },
    "params":{
        "dutyId":"d43471012885846d13babf1906430f2f"
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":true
}

更新查岗规则

服务描述

调用该接口，更新创建的查岗规则。

API定义

path	版本
/fire/zbb/duty/rule/update	0.0.1

请求参数

属性	类型	是否必填	说明
dutyId	String	是	查岗规则id。
dutyName	String	是	查岗规则名称，上限20字。
dutyTime	String	是	查岗规则cron表达式。
contentId	数组		不涉及。
	String	是	查岗内容id。
notifyUrl	数组	是	查岗结果通知类型和联系方式。
-type	String	是	查岗结果通知类型。
-url	String	是	查岗结果通知联系方式。

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	Boolean	更新结果。

请求示例

{
    "request":{
    "apiVer":"0.0.1"
    },
    "params":
    {
        "dutyName":"Q1查岗",
        "dutyId":"d43471012885846d13babf1906430f2f",
        "dutyTime":"0 0/30 9-17 * * ?",
        "contentId":[
            "1000002789"
        ],
        "notifyUrl":[
            {
                "type":"Ding",  // 钉钉机器人
                "url":"https://oapi.dingtalk.com/robot/send?access_token=6798602eefdee50d47ae09c94c98d57a4c8f69f03e984617efbd16f83328d748"
            }
        ]
    },
    "version":"1.0"
}

返回示例

{
    "code":200,"
    message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":true
}

查询查岗规则详情

服务描述

调用该接口，查询某一个查岗规则详情。

API定义

path	版本
/fire/zbb/duty/rule/get	0.0.1

请求参数

属性	类型	是否必填	说明
dutyId	String	是	查岗规则id。

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	JSON	不涉及。
-dutyId	String	查岗规则id。
-dutyName	String	查岗规则名称。
-dutyTime	String	查岗规则cron表达式。
-dutyStatus	String	查岗规则状态。
-contentId	数组
	String	查岗内容id。
-notifyUrl	数组	查岗结果通知类型和联系方式。
--type	String	查岗结果通知类型。
--url	String	查岗结果通知联系方式。

请求示例

{
    "request":{
    "apiVer":"0.0.1"
    },
    "params":{
    "dutyId":"d43471012885846d13babf1906430f2f"
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":{
        "dutyId":"d43471012885846d13babf1906430f2f",
        "dutyName":"Q1查岗",
        "dutyTime":"0 0/30 9-17 * * ?",
        "dutyStatus":"enable",
        "contentId":[
            "1000002789"
        ],
        "notifyUrl":[
            {
                "type":"Ding",
                "url":"https://oapi.dingtalk.com/robot/send?access_token=6798602eefdee50d47ae09c94c98d57a4c8f69f03e984617efbd16f83328d748"
            }
        ]
    }
}ch z z

查询查岗规则列表

服务描述

调用该接口，查询所有的查岗规则列表。

API定义

path	版本
/fire/zbb/duty/rule/list	0.0.1

请求参数

无

返回参数

属性	类型	说明
code	int	错误码，成功时返回200。
message	String	错误描述，成功时返回"success"。
localizedMsg	String	本地语言错误消息。
id	String	request id。
data	数组	不涉及。
-dutyId	String	查岗规则id。
-dutyName	String	查岗规则名称。
-dutyTime	String	查岗规则cron表达式。
-dutyStatus	String	查岗规则状态。
-contentId	数组
	String	查岗内容id。
-notifyUrl	数组	查岗结果通知类型和联系方式。
--type	String	查岗结果通知类型。
--url	String	查岗结果通知联系方式。

请求示例

{
    "request":{
    "apiVer":"0.0.1"
    },
    "version":"1.0"
}

返回示例

{
    "code":200,
    "message":"success",
    "id":"246da69e-40ad-4f44-955e-ac880f9867d7",
    "data":[
        {
            "dutyId":"d43471012885846d13babf1906430f2f",
            "dutyName":"Q1查岗",
            "dutyTime":"0 0/30 9-17 * * ?",
            "dutyStatus":"enable",
            "contentId":[
                "1000002789"
            ],
            "notifyUrl":[
                {
                    "type":"Ding",
                    "url":"https://oapi.dingtalk.com/robot/send?access_token=6798602eefdee50d47ae09c94c98d57a4c8f69f03e984617efbd16f83328d748"
                }
            ]
        },
        {
            "dutyId":"d43471012885846d13babf1906430f2g",
            "dutyName":"Q2查岗",
            "dutyTime":"0 * * * * ? *",
            "dutyStatus":"disable",
            "contentId":[
                "1000002788",
                "1000002789"
            ],
            "notifyUrl":[
                {
                    "type":"Ding",
                    "url":"https://oapi.dingtalk.com/robot/send?access_token=6798602eefdee50d47ae09c94c98d57a4c8f69f03e984617efbd16f83328d748"
                }
            ]
        }
    ]
}