调用ListReminds获取或搜索自定义监控规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListReminds |
系统规定参数。取值：ListReminds。 |
| PageNumber | Integer | 是 | 1 |
分页的页数。默认值为1，最小值为1，最大值为30。 |
| PageSize | Integer | 是 | 10 |
每页显示的条数，默认为10条，最大100条。 |
| Founder | String | 否 | 9527952795**** |
创建人的阿里云UID。 |
| NodeId | Long | 否 | 1234 |
规则的对象，任务节点ID。您可以根据任务节点ID搜索覆盖该任务节点的自定义监控规则。 |
| RemindTypes | String | 否 | FINISHED,ERROR |
触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。多个触发条件之间使用英文逗号（,）分隔。 |
| AlertTarget | String | 否 | 9527952795**** |
报警接收人的阿里云UID。 |
| SearchText | String | 否 | 模糊搜索规则名称 |
搜索规则名称。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| HttpStatusCode | Integer | 200 |
HTTP返回码。 |
| RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。 |
| ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
| ErrorCode | String | 1031203110005 |
错误码。 |
| Success | Boolean | true |
调用是否成功。 |
| Data | Object |
返回的自定义监控规则列表。 |
|
| PageNumber | Integer | 1 |
当前的页数。 |
| PageSize | Integer | 10 |
每页的大小。 |
| TotalCount | Integer | 100 |
自定义监控规则的总数。 |
| Reminds | Array of Reminds |
自定义监控规则列表。 |
|
| Founder | String | 952795**** |
规则创建人的阿里云UID。 |
| RemindId | Long | 1234 |
自定义监控规则的ID。 |
| AlertUnit | String | OWNER |
报警接收对象的粒度，包括OWNER（任务责任人）和OTHER（指定的人）。 |
| RemindType | String | FINISHED |
触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。 |
| DndEnd | String | 08:00 |
免打扰截止时间，格式为hh:mm。hh的取值范围为[0,23]，mm的取值范围为[0,59]。 |
| DndStart | String | 00:00 |
免打扰起始时间，格式为hh:mm。hh的取值范围为[0,23]，mm的取值范围为[0,59]。 |
| RemindUnit | String | NODE |
对象的类型，包括NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和BIZPROCESS（业务流程）。 |
| Useflag | Boolean | true |
规则是否开启，包括true（开启）和false（关闭）。 |
| RemindName | String | 规则名称 |
自定义监控规则的名称。 |
| AlertTargets | Array of String | 952795**** |
报警接收人的阿里云UID列表。 |
| NodeIds | Array of Long | 1234 |
当RemindUnit（对象类型）为NODE（任务节点）时，监控的节点ID列表。 |
| BizProcessIds | Array of Long | 9527 |
当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，监控的基线ID列表。 |
| ProjectIds | Array of Long | 1234 |
当RemindUnit（对象类型）为PROJECT（工作空间）时，监控的节点ID列表。 |
| BaselineIds | Array of Long | 9527 |
当RemindUnit（对象类型）为BASELINE（基线）时，监控的基线ID列表。 |
| AlertMethods | Array of String | SMS |
报警的方式，包括MAIL（邮件）、SMS（短信）和PHONE（电话，仅DataWorks专业版及以上版本支持）。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListReminds
&PageNumber=1
&PageSize=10
&Founder=9527952795****
&NodeId=1234
&RemindTypes=FINISHED,ERROR
&AlertTarget=9527952795****
&SearchText=模糊搜索规则名称
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
0000-ABCD-EFG****
The specified parameters are invalid.
1031203110005
true
1
10
100
952795****
1234
OWNER
FINISHED
08:00
00:00
NODE
true
规则名称
952795****
1234
9527
1234
9527
SMS
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "The specified parameters are invalid.",
"ErrorCode" : 1031203110005,
"Success" : true,
"Data" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"Reminds" : {
"Founder" : "952795****",
"RemindId" : 1234,
"AlertUnit" : "OWNER",
"RemindType" : "FINISHED",
"DndEnd" : "08:00",
"DndStart" : "00:00",
"RemindUnit" : "NODE",
"Useflag" : true,
"RemindName" : "规则名称",
"AlertTargets" : "952795****",
"NodeIds" : 1234,
"BizProcessIds" : 9527,
"ProjectIds" : 1234,
"BaselineIds" : 9527,
"AlertMethods" : "SMS"
}
}
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
| 429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | 对该资源的请求已超过您的每日可用上限。 |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙，请稍后再试。 |
| 429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁，请尝试放缓请求速度。 |
| 500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | 该地域还未开放DataWorks的API服务，请尝试其它地域。 |
| 500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误，请稍后再试。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/171133.html
