Help Center> Data Lake Insight> API Reference> APIs Related to Flink Jobs> Creating an IEF Message Channel
View PDF

Creating an IEF Message Channel

Function

This API is used to create an IEF message channel.

Debugging

You can debug this API in API Explorer.

URI

  • URI format

    POST /v1/{project_id}/edgesrv/message-channel

  • 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

node_id

Yes

String

ID of the edge node specified for creating an IEF message channel. The value is in UUID format.

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 
    {
    "node_id": "e0c2b85a-2ff7-4cbc-accd-2418dca14fa8"
}
  • Example response 
    {
    "is_success": "true",
    "message": "IEF message channel created successfully."
}

Status Codes

Table 4 describes the status code.

Table 4 Status codes

Status Code

Description

200

The IEF message channel is successfully created.

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.