文档首页/ AI开发平台ModelArts/ API参考/ Workflow工作流管理/ 新建消息订阅Subscription
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

新建消息订阅Subscription

功能介绍

为Workflow工作流添加消息订阅功能。工作流已订阅的事件发生时，会产生消息提醒。

接口约束

无

调试

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

URI

POST /v2/{project_id}/workflows/{workflow_id}/subscriptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。

workflow_id

是

String

工作流的ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

created_at

否

String

创建时间。

subscription_id

否

String

订阅ID，唯一性标识。创建订阅时，后台自动生成。

topic_urns

是

Array of strings

订阅的主题。

entity

否

String

订阅的主体。

events

否

Array of strings

订阅的事件。

响应参数

状态码： 201

表3 响应Body参数

参数

参数类型

描述

created_at

String

创建时间。

subscription_id

String

订阅ID，唯一性标识。创建订阅时，后台自动生成。

topic_urns

Array of strings

订阅的主题。

entity

String

订阅的主体。

events

Array of strings

订阅的事件。

请求示例

创建消息订阅。设置订阅的主题为“fengbin26”，订阅的主体为“238947895793875835893490”，订阅的事件为“[ "*:failed,completed", "job_step:stop" ]”。订阅Workflow失败、完成和job_step节点停止三个事件，发生这三个事件时，会有消息提醒。

POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/subscriptions

{
  "topic_urns" : [ "fengbin26" ],
  "entity" : "238947895793875835893490",
  "events" : [ "*:failed,completed", "job_step:stop" ]
}

响应示例

状态码： 201

OK

{
  "created_at" : "2022-11-24T17:30:48.958322+08:00",
  "subscription_id" : "42e8a77a-512e-4d0e-a56e-4b003db82577",
  "topic_urns" : [ "fengbin26" ],
  "entity" : "238947895793875835893490",
  "events" : [ "*:failed,completed", "job_step:stop" ]
}

状态码

状态码

描述

201

OK

错误码

请参见错误码。

相关文档