文档首页/ 数智融合计算服务/ API参考/ API/ fabric-admin/ 消息管理/ 创建消息通知策略
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

创建消息通知策略

功能介绍

创建消息通知策略。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST https://localhost.com/v1/workspaces/{workspace_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

  • 参数解释：工作空间ID。

  • 约束限制：不涉及。

  • 取值范围：获取方法，请参见获取工作空间ID。

  • 默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户Token。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

message_notification_policy_list

是

Array of CreateMessageNotificationPolicy objects

消息通知策略。
表4 CreateMessageNotificationPolicy

参数

是否必选

参数类型

描述

message_type

是

String

  • 参数解释：消息类型。

  • 约束限制：不涉及。

  • 取值范围：

    • job：任务执行结果。

  • 默认取值：job。

name_pattern

是

String

  • 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。

  • 约束限制：例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

notification_types

是

Array of strings

通知类型。SUCCESS:成功通知；FAILED：失败通知。

topic_urn

是

String

  • 参数解释：消息通知主题。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

id

String

  • 参数解释：消息通知策略ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

message_type

String

  • 参数解释：消息类型。

  • 约束限制：不涉及。

  • 取值范围：

    • job：任务执行结果。

  • 默认取值：job。

name_pattern

String

  • 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。

  • 约束限制：例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

notification_types

Array of strings

通知类型。SUCCESS:成功通知；FAILED：失败通知。

topic_urn

String

  • 参数解释：消息通知主题。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 408

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求示例

无

响应示例

无

状态码

状态码

描述

200

消息通知策略响应体

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

404

Not found error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码。

父主题： 消息管理

相关文档