文档首页/ AI开发平台ModelArts/ API参考/ Workflow工作流管理/ 新建消息订阅Subscription - CreateWorkflowSubscriptions
更新时间：2025-11-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建消息订阅Subscription - CreateWorkflowSubscriptions

功能介绍

新建消息订阅Subscription接口用于创建新的消息订阅，以便用户接收工作流执行过程中的通知。

该接口适用于以下场景：当用户需要在工作流执行的关键阶段（如开始、结束、失败等）接收通知时，可以通过此接口创建订阅。使用该接口的前提条件是用户已登录且具有创建消息订阅的权限。创建操作完成后，系统将生成一个新的订阅，并返回订阅的详细信息，包括订阅ID、创建时间等。若用户无权限操作或输入的订阅参数无效，接口将返回相应的错误信息。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts CreateWorkflowSubscriptions。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    modelarts:workflow:update

    Write

    workflow *

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

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

错误码

请参见错误码。

相关文档