新增订阅 - CreateEventsubs
功能介绍
本接口用于新增订阅。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/event-subs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法,请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。请参见认证鉴权-Token认证。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enable |
否 |
Boolean |
参数解释: 是否启用订阅。 约束限制: 不涉及 取值范围:
默认取值: false |
|
name |
否 |
String |
参数解释: 订阅名称,可使用自动生成的由前缀“dis-”加4位随机字符或数字组成的名称,例如:dis-xxxx,也可自定义。 约束限制: 输入不能为空。 取值范围: 不涉及 默认取值: 不涉及。 |
|
topic_type |
是 |
Integer |
参数解释: 订阅类型。 约束限制: 不涉及 取值范围:
默认取值: 0 |
|
topic_name |
是 |
String |
参数解释: SMN主题名称或者是DIS通道名称,不能为空。订阅类型为“SMN”时,SMN主题名称为用户选择的主题,订阅类型为“DIS通道”时,DIS通道可以是用户选择的DIS通道名称 约束限制: 选择对应的订阅类型,必须有相应的SMN主题或者DIS通道,没有的话需要去创建。 取值范围: 不涉及 默认取值: 不涉及。 |
响应参数
状态码:200
正常返回
无
请求示例
新增订阅。
POST https://{Endpoint}/v1/{project_id}/event-subs
{
"enable" : true,
"events_ids" : "dis_event.000\ndis_event.001",
"name" : "dis-test1",
"topic_name" : "dis-boce-nodelete",
"topic_type" : 1,
"topic_urn" : "urn:smn:cn-southwest-2:575ae927fc644f22b5c5af5209b7cf51:test"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回 |
错误码
请参见错误码。