更新消息订阅Subscription
功能介绍
更新消息订阅Subscription接口用于修改已创建的消息订阅的配置。
该接口适用于以下场景：当用户需要更新消息订阅的主题或其他配置信息时，可以通过此接口进行修改。使用该接口的前提条件是用户已登录且具有更新消息订阅的权限。更新操作完成后，指定的订阅配置将被更新，并返回更新后的订阅详细信息。若订阅不存在或用户无权限操作，接口将返回相应的错误信息。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/workflows/{workflow_id}/subscriptions/{subscription_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
subscription_id |
是 |
String |
参数解释：工作流的消息订阅ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
workflow_id |
是 |
String |
参数解释：工作流的ID。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
created_at |
否 |
String |
参数解释：创建时间。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
subscription_id |
否 |
String |
参数解释：订阅ID，唯一性标识。 约束限制：创建订阅时，后台自动生成。 取值范围：不涉及。 默认取值：不涉及。 |
|
topic_urns |
是 |
Array of strings |
参数解释：订阅的主题。 约束限制：不涉及。 |
|
entity |
否 |
String |
参数解释：订阅的主体。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
events |
否 |
Array of strings |
参数解释：订阅的事件。 约束限制：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_at |
String |
参数解释：创建时间。 取值范围：不涉及。 |
|
subscription_id |
String |
参数解释：订阅ID，唯一性标识。 取值范围：不涉及。 |
|
topic_urns |
Array of strings |
参数解释：订阅的主题。 |
|
entity |
String |
参数解释：订阅的主体。 取值范围：不涉及。 |
|
events |
Array of strings |
参数解释：订阅的事件。 |
请求示例
更新订阅信息
PUT https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/subscription/f1642618-43eb-4ab1-a0b1-9cc58418
{
"topic_urns" : [ "fengbin26" ],
"entity" : "238947895793875835893490",
"events" : [ "*:failed,completed", "job_step:stop" ]
}
响应示例
状态码：200
订阅信息。
{
"topic_urns" : [ "fengbin26" ],
"entity" : "238947895793875835893490",
"events" : [ "*:failed,completed", "job_step:stop" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
订阅信息。 |
错误码
请参见错误码。
