文档首页/ 事件网格 EG/ API参考/ API/ 事件订阅管理/ 查询事件订阅列表
更新时间：2025-09-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询事件订阅列表

功能介绍

查询事件订阅列表，支持指定事件通道。

URI

GET /v1/{project_id}/subscriptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户资源空间ID
表2 Query参数

参数

是否必选

参数类型

描述

channel_id

否

String

指定查询的事件通道ID

offset

否

Integer

偏移量，表示从此偏移量开始查询，偏移量不能小于0

limit

否

Integer

每页显示的条目数量，不能小于1或大于1000

sort

否

String

指定查询排序

name

否

String

指定查询的事件订阅名称，精准匹配

fuzzy_name

否

String

指定查询的事件订阅名称，模糊匹配

connection_id

否

String

目标连接 id

enterprise_project_id

否

String

创建订阅时所使用的企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of SubscriptionInfo objects

对象列表
表5 SubscriptionInfo

参数

参数类型

描述

id

String

订阅ID

name

String

订阅名称

description

String

订阅描述

type

String

类型

status

String

状态

channel_id

String

通道ID

channel_name

String

通道名称

used

Array of SubscriptionUsedInfo objects

标签信息

sources

Array of SubscriptionSourceInfo objects

订阅源列表

targets

Array of SubscriptionTargetInfo objects

订阅目标列表

created_time

String

创建时间

updated_time

String

更新时间
表6 SubscriptionUsedInfo

参数

参数类型

描述

resource_id

String

关联资源ID

owner

String

管理租户账号

description

String

描述
表7 SubscriptionSourceInfo

参数

参数类型

描述

id

String

订阅源ID

name

String

订阅的事件源名称

provider_type

String

订阅的事件源的提供方类型

detail

Object

订阅的事件源参数列表

filter

Object

订阅事件源的匹配过滤规则

created_time

String

创建时间

updated_time

String

更新时间
表8 SubscriptionTargetInfo

参数

参数类型

描述

id

String

订阅目标ID

name

String

订阅的事件目标名称

provider_type

String

订阅的事件目标的提供方类型

connection_id

String

订阅的事件目标使用的目标链接ID

detail

Object

订阅的事件目标参数列表

kafka_detail

KafkaTargetDetail object

订阅的kafka事件目标参数列表，该字段序列化后总长度不超过1024字节

smn_detail

SmnTargetDetail object

订阅的SMN事件目标参数列表，该字段序列化后总长度不超过1024字节

eg_detail

EgTargetDetail object

订阅的事件eg通道目标参数列表，该字段序列化后总长度不超过1024字节，eg通道目标必填

apigw_detail

ApigwTargetDetail object

订阅的事件APIGWurl目标参数列表，该字段序列化后总长度不超过1024字节，APIGW目标必填

retry_times

Integer

重试次数

transform

TransForm object

订阅的事件目标转换规则

dead_letter_queue

DeadLetterQueue object

订阅的死信参数列表

created_time

String

创建时间

updated_time

String

更新时间

rocketmq_detail

RocketmqTargetDetail object

事件订阅中RocketMQ目标端的参数
表9 KafkaTargetDetail

参数

参数类型

描述

topic

String

主题

keyTransform

keyTransform object

键值规则
表10 keyTransform

参数

参数类型

描述

type

String

键值规则类型

value

String

键值规则，键值规则为VARIABLE，CONSTANT时必填

template

String

键值规则模板，键值规则为VARIABLE时必填
表11 SmnTargetDetail

参数

参数类型

描述

urn

String

主题urn

agency_name

String

委托名称

subject_transform

subject_transform object

标题规则
表12 subject_transform

参数

参数类型

描述

type

String

标题规则类型

value

String

标题规则

template

String

标题规则模板，键值规则为VARIABLE时必填
表13 EgTargetDetail

参数

参数类型

描述

target_project_id

String

目标项目id

target_channel_id

String

目标通道id

target_region

String

目标region

cross_region

Boolean

跨region开关

agency_name

String

委托名称
表14 ApigwTargetDetail

参数

参数类型

描述

url

String

目标url

invocation_http_parameters

InvocationHttpParameters object

调用Http的参数
表15 InvocationHttpParameters

参数

参数类型

描述

header_parameters

Array of HeaderParameter objects

对象列表
表16 HeaderParameter

参数

参数类型

描述

is_value_secret

Boolean

是否加密

key

String

header的key值

value

String

header的value值
表17 DeadLetterQueue

参数

参数类型

描述

type

String

队列类型

instance_id

String

实例id

connection_id

String

目标连接id

topic

String

主题
表18 RocketmqTargetDetail

参数

参数类型

描述

topic

String

topic名称

key_transform

TransForm object

转换规则
表19 TransForm

参数

参数类型

描述

type

String

转换规则类型

value

String

常量类型规则时，字段为常量内容定义；

变量类型规则时，为变量定义，内容必须为JsonObject字符串。

变量最多支持100个，且不支持嵌套结构定义；

变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符；

变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。

template

String

变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。

请求示例

查询事件订阅列表

GET https://{endpoint}/v1/{project_id}/subscriptions

响应示例

状态码：200

事件订阅列表

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

状态码

状态码

描述

200

事件订阅列表

错误码

请参见错误码。

父主题： 事件订阅管理