Help Center> Data Lake Insight> API Reference> APIs Related to Flink Jobs> Reporting the Flink Edge Job Status
View PDF

Reporting the Flink Edge Job Status

Function

This API is used to process the reported information about the Flink job status on the edge.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1/{project_id}/edgesrv/job-report

  • 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

  • Example request
    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    jobs

    Yes

    Array of Objects

    A list of jobs. For details, see Table 3.

    msg_confirm_topic

    Yes

    String

    Topic for confirming messages.

    message_id

    Yes

    String

    Message ID.
    Table 3 jobs parameters

    Parameter

    Mandatory

    Type

    Description

    job_id

    No

    Integer

    Job ID

    status

    Yes

    String

    Job status

    create_time

    Yes

    Integer

    Timestamp

    exceptions

    No

    String

    Job exception information

    metrics

    No

    String

    Job metric information

    plan

    No

    String

    Job execution plan.

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 
    {
    "jobs": [
        {
            "create_time": 1591104868201,
            "job_id": 99270,
            "exceptions": {
                "error_id": "Agent.51000",
                "error_type": "JOB_SUBMIT_EXCEPTION",
                "error_cause": "agent_submit_job_exception_error",
                "exception": "",
                "error_time": "2020-06-02 13:34:28"
            },
            "status": "job_submit_fail"
        }
    ],
    "msg_confirm_topic": "hw/events/messages/dli/message/confirm",
    "message_id": "uuid"
}
  • Example response 
    {
    "is_success": "true",
"message": "The IEF Flink job status information is successfully reported."
}

Status Codes

Table 5 describes the status code.

Table 5 Status codes

Status Code

Description

200

The IEF Flink job status is reported successfully.

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.