文档首页/ 数据接入服务 DIS/ API参考/ API说明/ 事件管理/ 更新事件订阅 - UpdateEventsubs
更新时间:2025-11-07 GMT+08:00
分享

更新事件订阅 - UpdateEventsubs

功能介绍

本接口用于更新事件订阅。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/event-subs/{subscription_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法,请参见获取项目ID

约束限制

不涉及

取值范围

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值

不涉及

subscription_id

String

参数解释

订阅ID。

约束限制

不涉及

取值范围

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。请参见认证鉴权-Token认证

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

enable

Boolean

参数解释

是否启用订阅。

约束限制

不涉及

取值范围

  • true:启用订阅。

  • false:停用订阅。

默认取值

false

event_ids

Array

参数解释

订阅包含的事件类型,对应的事件id集合,多个event_id用逗号分隔,每一种事件类型对应了固定的事件event_id。

约束限制

不涉及

取值范围

  • dis_event.000: 转储任务恢复。

  • dis_event.001:转储任务异常

  • dis_event.002:配额不足

  • dis_event.003:流控受限

  • dis_event.004:通道自动扩缩容成功

  • dis_event.005:通道自动扩缩容失败

  • dis_event.006:通道流量异常

  • dis_event.007:通道流量恢复

  • dis_event.008:通道手动扩缩容失败

默认取值

不涉及

event_streamids

Array

参数解释

订阅通道的通道id的集合,如果订阅通道开关关闭,表示默认订阅所有的通道,开关打开,可以选择需要订阅的通道id,多个通道id用逗号隔开。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

name

String

参数解释

更新订阅的名称。

约束限制

不涉及

取值范围

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值

不涉及

topic_name

String

参数解释

SMN主题名称或者是DIS通道名称,不能为空。订阅类型为“SMN”时,此字段是用户选择的SMN主题,订阅类型为“DIS通道”时,此字段为用户是用户选择的DIS通道名称。

约束限制

选择对应的订阅类型,必须有相应的SMN主题或者DIS通道,没有的话需要去创建。

取值范围

不涉及

默认取值

不涉及

topic_type

Integer

参数解释

订阅类型,订阅类型为SMN通知时,值为0,订阅类型为DIS通道时,值为1。

约束限制

不涉及

取值范围

  • 0:SMN通知。

  • 1: DIS通道。

默认取值

不涉及

topic_urn

String

参数解释

主题的统一资源名称urn。

约束限制

订阅类型为DIS通道时,值为null;订阅类型为SMN主题时,值的类型为string类型的拼接字符串,格式为"urn:smn:region_id:projectid:smn主题"。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

正常返回

请求示例

  • 更新事件订阅为SMN通知。

    PUT https://{Endpoint}/v1/{project_id}/event-subs/{subscription_id}
    
    {
      "enable" : true,
      "events_ids" : "0: \"dis_event.000\"\n1:\"dis_event.001\"",
      "event_streamids" : [ ],
      "name" : "dis-test1",
      "topic_name" : "test",
      "topic_type" : 0,
      "topic_urn" : "urn:smn:cn-southwest-2:575ae927fc644f22b5c5af5209b7cf51:test"
    }
  • 更新事件订阅类型为DIS通道。

    {
      "enable" : true,
      "events_ids" : "0: \"dis_event.000\"\n1: \"dis_event.001\"",
      "event_streamids" : "0: \"Xs5eBSKtWBbFJR2xxxx\"\n1: \"e4CH131AqCyjucWxxxx\"",
      "name" : "dis-test1",
      "topic_name" : "dis-boce-notelete",
      "topic_type" : 1,
      "topic_urn" : null
    }

响应示例

状态码

状态码

描述

200

正常返回

错误码

请参见错误码

相关文档