创建系统订阅
功能介绍
创建系统订阅
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/routemgr/exchanger/systemevents
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
ief-instance-id |
否 |
String |
铂金版实例ID，专业版实例为空值 |
Content-Type |
是 |
String |
消息体的类型（格式），默认取值为“application/json” |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
systemevent |
否 |
EventCreateDetail object |
系统订阅基本信息 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
否 |
String |
系统订阅名称。只允许小写英文字符、数字、下划线、中划线，最大长度64，同一个账号中创建的系统订阅和消息规则名唯一 |
description |
否 |
String |
描述。最大长度255，不允许^~#$%&*<>()[]{}'"\ |
events |
否 |
String |
系统订阅主题。每个主题由“{边缘资源}/{操作}”组成，多个主题使用逗号（,）进行分隔，支持如下主题：
|
target |
否 |
String |
目的端点ID |
target_resource |
否 |
EndpointResource object |
目的端点资源 |
响应参数
状态码： 201
参数 |
参数类型 |
描述 |
|---|---|---|
systemevent |
Event object |
系统订阅详情 |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
更新时间 |
请求示例
创建系统订阅，订阅的系统主题为节点上线。
{
"systemevent" : {
"name" : "aa",
"description" : "",
"events" : "edgeNode/online",
"target_resource" : {
"resource" : "https://www.fake.com"
},
"target" : "591ba510-8c62-41b8-a0c3-d94262ef97ef"
}
}
响应示例
状态码： 201
创建成功
{
"systemevent" : {
"id" : "b79f4d8e-4549-4da4-9a9c-a9d13452c7d6",
"project_id" : "ed202955e111444e8ced21a1bd75fc59",
"created_at" : "2022-11-02T07:17:01.372735871Z",
"updated_at" : "2022-11-02T07:17:01.372735998Z",
"name" : "aa",
"description" : "",
"in_using" : true,
"events" : "edgeNode/online",
"target" : {
"name" : "apigw",
"description" : "",
"type" : "apigw",
"properties" : {
"domain_id" : "d0857ebddc514a7381c3673363e61337"
},
"ief_instance_id" : "38898a99-d67c-41f8-a8cb-8c53d6d297ba",
"is_shared" : false,
"id" : "591ba510-8c62-41b8-a0c3-d94262ef97ef",
"project_id" : "ed202955e111444e8ced21a1bd75fc59",
"created_at" : "2022-06-02T11:15:26.29972+08:00",
"updated_at" : "2022-06-02T11:15:26.29972+08:00"
},
"target_resource" : {
"resource" : "https://www.fake.com"
},
"fail_messages" : 0,
"success_messages" : 0,
"delete_at" : 0
}
}
状态码
状态码 |
描述 |
|---|---|
201 |
创建成功 |
错误码
请参见错误码。
