Querying the System Subscription Event List

Updated on 2023-11-23 GMT+08:00

View PDF

Function

This API is used to query the system subscription event list.

URI

GET /v2/{project_id}/routemgr/exchanger/systemevents/{event_id}

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
event_id	Yes	String	System subscription event name.

Request

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
ief-instance-id	No	String	Platinum edition instance ID. This parameter is left blank for a professional edition instance.
Content-Type	Yes	String	Message body type (format). The default value is application/json.

Response

Status code: 200

**Table 3** Parameter in the response body
Parameter	Type	Description
systemevent	Event object	Details of the system subscription events.

**Table 4** Event
Parameter	Type	Description
id	String	System subscription event ID.
name	String	System subscription event name. The value can contain a maximum of 64 characters, including lowercase letters, digits, underscores (_), and hyphens (-). Names of system subscription events and message rules created under the same account must be unique.
project_id	String	ID of the project to which the system subscription event belongs.
created_at	String	Creation time.
updated_at	String	Update time.
description	String	Description. The value can contain a maximum of 255 characters. The following characters are not allowed: ^~#$%&*<>()[]{}'"\
in_using	Boolean	Whether the system subscription rule is enabled. The default value is true, indicating that the rule is enabled.
events	String	System subscription event topic. Each topic consists of edge resource/operation. Multiple topics are separated by commas (,). The following topics are supported: edgeNode/offline: node offline edgeNode/online: node online edgeNode/all: node offline and node online deployment/created: containerized application creation deployment/updated: containerized application update deployment/deleted: containerized application deletion deployment/all: containerized application creation, update, and deletion instance/created: application instance creation instance/updated: application instance update instance/deleted: application instance deletion instance/all: application instance creation, update, and deletion
target	EndpointObjResp object	Destination endpoint.
target_resource	Map<String,String>	Destination endpoint's resource attribute.
success_messages	Integer	Times that messages are successfully sent
fail_messages	Integer	Times that messages failed to send
delete_at	Integer	Deletion time.

**Table 5** EndpointObjResp
Parameter	Type	Description
created_at	String	Creation time.
description	String	Endpoint description. The value can contain a maximum of 255 characters. The following characters are not allowed: ^~#$%&*<>()[]{}'"\
id	String	Endpoint ID.
ief_instance_id	String	Platinum edition instance ID. This parameter is left blank for a professional edition instance.
is_shared	Boolean	Whether the endpoint is shared.
name	String	Endpoint name. The value can contain a maximum of 64 characters, including letters, digits, underscores (_), and hyphens (-). Endpoint names created under the same account must be unique.
project_id	String	Project ID.
properties	Map<String,Object>	Endpoint properties to be displayed. Example: dis: {"domain_id":"user's domain id"} servicebus: {"service_port":8080} apigw: {"domain_id":"user's domain id"}
type	String	Endpoint type. The options are as follows: dis servicebus apigw
updated_at	String	Update time.

Example Request

None

Example Response

Status code: 200

Query succeeded.

{
  "systemevent" : {
    "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
  }
}