Send Control Area Information

This interface allows you to set the control area information for a network port.

API Path

{CLTPlatform-ip}:8086/processor/setPortControlArea

• Replace {CLTPlatform-ip} with the corresponding IP address.
• The request port is 8086.

Protocol

HTTP

Method

POST

Request Parameter

• Set the Content-Type of the request body to application/json.

Parameter Name	Description	Required	Type	Data Dictionary	Limit	Example
command	Command type	Yes	string			processor/setPortControlArea
data	Data	Yes	object
data >> index	Sender index (starting from 0)	Yes	int
data >> portControlArea	Network port control area	Yes	array
data >> portControlArea >> portIndex	Network port index	Yes	int
data >> portControlArea >> x	Leftmost position	Yes	int
data >> portControlArea >> y	Topmost position	Yes	int
data >> portControlArea >> width	Width	Yes	int
data >> portControlArea >> height	Height	Yes	int

Request Example

{
    "command": "processor/setPortControlArea",
    "data": {
        "index": 0,
        "portControlArea": [
            {
                "portIndex": 0,
                "x": 0,
                "y": 0,
                "width": 1920,
                "height": 1080
            }
        ]
    }
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Limit	Example
command	Command type	Yes	string			processor/setPortControlArea
code	Status code	Yes	int
message	Message	Yes	string
data	Data	No	object

Response Example

{
    "code": 20000,
    "command": "processor/setPortControlArea",
    "data": {},
    "message": "Common_Success"
}

Detailed Description

* 2023.11.16
    1. Standardized description.