Help Center> Data Lake Insight> API Reference> APIs Related to Flink Jobs> Action Callback of Flink Edge Jobs
View PDF

Action Callback of Flink Edge Jobs

Function

This API is used to process the action callback information of an IEF Flink job.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1/{project_id}/edgesrv/messages

  • 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

message_id

Yes

String

Message ID

state

No

Object

Status description For details, see Table 3.
Table 3 state parameter description

Parameter

Mandatory

Type

Description

phase

Yes

String

Current status

reason

No

String

Error reason

Response

Table 4 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 
    {
    "message_id": "5a3f33f7-bcd9-42bd-a8ca-9b612c36b3ase",
    "state": {
        "phase": "FAILED",
        "reason": "flink job submit failed,"
    }
}
  • Example response 
    {
    "is_success": "true",
"message": "The action of the edge Flink job is called back successfully."
}

Status Codes

Table 5 describes the status code.

Table 5 Status codes

Status Code

Description

200

The action of the Flink edge job is successfully called back.

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.