- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
- SDK参考
- Edgectl使用指南
- 合作伙伴对接指南
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询系统订阅列表
功能介绍
查询系统订阅列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/routemgr/exchanger/systemevents
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
系统订阅名称 |
|
limit |
否 |
Integer |
查询返回记录的数量限制 |
|
offset |
否 |
Integer |
偏移量，表示查询该偏移量后面的记录 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
ief-instance-id |
否 |
String |
铂金版实例ID，专业版实例为空值 |
|
Content-Type |
是 |
String |
消息体的类型（格式），默认取值为“application/json” |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
数目 |
|
systemevents |
Array of Event objects |
系统订阅详情列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
系统订阅事件ID |
|
name |
String |
系统订阅事件名称。只允许小写英文字符、数字、下划线、中划线，最大长度64，同一个账号中创建的系统订阅和消息规则名唯一 |
|
project_id |
String |
系统订阅事件所属项目ID |
|
created_at |
String |
创建时间 |
|
updated_at |
String |
更新时间 |
|
description |
String |
描述，最大长度255，不允许^~#$%&*<>()[]{}'"\ |
|
in_using |
Boolean |
是否启用系统订阅规则，默认为true（启用） |
|
events |
String |
系统订阅事件主题。每个主题由“{边缘资源}/{操作}”组成，多个主题使用逗号（,）进行分隔，支持如下主题：
|
|
target |
EndpointObjResp object |
目的端点 |
|
target_resource |
Map<String,String> |
目的端点资源属性 |
|
success_messages |
Integer |
成功次数 |
|
fail_messages |
Integer |
失败次数 |
|
delete_at |
Integer |
删除时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created_at |
String |
创建时间 |
|
description |
String |
端点描述，最大长度255，不允许^~#$%&*<>()[]{}'"\ |
|
id |
String |
端点ID |
|
ief_instance_id |
String |
铂金版实例ID，如果为空则表示是专业版实例。 |
|
is_shared |
Boolean |
是否共享 |
|
name |
String |
端点名称，只允许中文字符、英文字符、数字、下划线、中划线，最大长度64 同一个账号中创建的端点名唯一 |
|
project_id |
String |
项目ID |
|
properties |
Map<String,Object> |
端点的属性，端点需要对外展示的属性，示例：
|
|
type |
String |
端点类型。枚举值：
|
|
updated_at |
String |
更新时间 |
请求示例
无
响应示例
状态码： 200
查询成功
{
"count" : 2,
"systemevents" : [ {
"id" : "e99ec7d8-82ab-4950-a05b-0e3fcefb4b38",
"project_id" : "xxx",
"created_at" : "2022-09-14T17:20:43.642043+08:00",
"updated_at" : "2022-09-14T17:20:43.642043+08:00",
"name" : "test1",
"description" : "",
"in_using" : true,
"events" : "edgeNode/offline",
"target" : {
"name" : "test-huyurui",
"description" : "",
"type" : "apigw",
"properties" : {
"domain_id" : "d0857ebddc514a7381c3673363e61337"
},
"ief_instance_id" : "",
"is_shared" : false,
"id" : "0ee2e86e-1912-4144-be5a-d9153347d8c2",
"project_id" : "xxxx",
"created_at" : "2022-09-14T15:44:04.755785+08:00",
"updated_at" : "2022-09-14T15:44:04.755785+08:00"
},
"target_resource" : {
"resource" : "xxxx"
},
"fail_messages" : 14,
"success_messages" : 0,
"delete_at" : 0
}, {
"id" : "8683a0db-54ad-43a7-bbda-9937d1abe117",
"project_id" : "xxxx",
"created_at" : "2022-08-27T12:40:55.875613+08:00",
"updated_at" : "2022-08-27T12:40:55.875613+08:00",
"name" : "instcreated",
"description" : "",
"in_using" : true,
"events" : "instance/created",
"target" : {
"name" : "apigw",
"description" : "",
"type" : "apigw",
"properties" : {
"domain_id" : "d0857ebddc514a7381c3673363e61337"
},
"ief_instance_id" : "a",
"is_shared" : false,
"id" : "591ba510-8c62-41b8-a0c3-d94262ef97ef",
"project_id" : "xxxxx",
"created_at" : "2022-06-02T11:15:26.29972+08:00",
"updated_at" : "2022-06-02T11:15:26.29972+08:00"
},
"target_resource" : {
"resource" : "xxxxx"
},
"fail_messages" : 23,
"success_messages" : 0,
"delete_at" : 0
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功 |
错误码
请参见错误码。
