获取用户订阅列表 - ListEventsubs
功能介绍
本接口用于获取用户订阅列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/event-subs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法,请参见获取项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母和数字组成,且长度为[1-64]个字符。 默认取值: 不涉及项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。请参见认证鉴权-Token认证。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
quota |
Integer |
参数解释: 订阅创建的配额。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 10 |
|
used |
Integer |
参数解释: 订阅已使用的配额。 约束限制: 不涉及 取值范围: 大于1的整数。 默认取值: 不涉及 |
|
eventSubscriptions |
Array of eventSubscriptionsinfo objects |
参数解释: 订阅详情。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 订阅ID,值唯一。 约束限制: 不涉及 取值范围: 由英文字母和数字组成,且长度为19个字符。 默认取值: 不涉及 |
|
name |
String |
参数解释: 订阅名称,值唯一。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
enable |
Boolean |
参数解释: 订阅的状态。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
event_ids |
Array |
参数解释: 订阅包含的事件类型,对应的事件id集合,多个event_id用逗号分隔,每一种事件类型对应了固定的事件event_id。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
event_streamids |
String |
参数解释: 订阅通道的通道id,如果创建时未选择指定的订阅通道则显示所有通道id,指定了订阅通道则只显示指定的通道id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
event_names |
String |
参数解释: 订阅通道的通道名称,如果创建时未选择指定的订阅通道则显示所有通道名称,指定了订阅通道则只显示指定的通道名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
create_time |
Integer |
参数解释: 订阅创建的时间,13位UNIX时间戳格式。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
topic_name |
String |
参数解释: 订阅类型选择为DIS通道时,勾选的通道名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取用户订阅列表。
GET https://{Endpoint}/v1/{project_id}/event-subs
响应示例
状态码:200
正常返回
{
"quota" : 10,
"used" : 1,
"eventSubscriptions" : {
"id" : "s1r0SpFA2qksK7rT5lM",
"name" : "dis_Subscribe",
"enable" : false,
"enableStream" : true,
"eventLatestSend" : 0,
"event_ids" : "- dis_event.001\n- dis_event.002",
"event_streamids" : "E7WZh64GXi6zgW1q04f",
"create_time" : 1628669309208,
"update_time" : 1753774279974,
"topic_name" : "dis-yNkP"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常返回 |
错误码
请参见错误码。