Help Center> Data Lake Insight> API Reference> APIs Related to Flink Jobs> Reporting an IEF System Event
View PDF

Reporting an IEF System Event

Function

This API is used to report IEF system events.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1/{project_id}/edgesrv/system-events

  • Parameter description
    Table 1 URI parameter

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

event_type

Yes

String

Resource type

operation

Yes

String

Operation type of a resource

timestamp

Yes

Integer

Timestamp when an event is generated

topic

Yes

String

Topic to which a message is sent

name

Yes

String

Resource name

attributes

No

String

Attribute of a resource

Response

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

Message content

Example

  • Example request 
    {
    "event_type": "deployment",
    "operation": "updated",
    "timestamp": 1591879887,
    "topic": "$hw/events/deployment/+/updated",
    "name": "edge-cs",
    "attributes": {}
}
  • Example response 
    {
    "is_success": "true",
"message": "The IEF system event is successfully processed."
}

Status Codes

Table 4 describes the status code.

Table 4 Status codes

Status Code

Description

200

The IEF system event is successfully processed.

400

Request error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.