Forwarding Rules Interface¶
POST Update Forwarding Rule¶
POST /cdn/layer4/rules/updateRule
Body Request Parameters
{
"limitConn": "",
"ruleId": 81,
"types": "off",
"protocolType": "udp",
"node": "line_1",
"proxyProtocol": "off",
"hyPort": "133",
"listenPort": "1333",
"originAddress": "12.12.12.2"
}
Request Parameters¶
| Name | Location | Type | Required | Chinese Name | Description |
|---|---|---|---|---|---|
| Authorization | header | string | No | none | |
| body | body | object | No | none | |
| » hyPort | body | string | Yes | Forwarding Port | none |
| » limitConn | body | integer(int32) | No | Rate Limiting | none |
| » listenPort | body | string | Yes | Origin Port | none |
| » node | body | string | Yes | Instance | none |
| » originAddress | body | string | Yes | Origin Address | Multiple addresses separated by semicolons (;) |
| » protocolType | body | string | Yes | Forwarding Protocol | tcp： indicates TCP |
| » proxyProtocol | body | string | Yes | proxy_protocol | off: indicates disabled |
| » remark | body | string | No | none | |
| » ruleId | body | integer(int64) | Yes | Rule ID | none |
| » types | body | string | Yes | Session Persistence | off: indicates no; on: indicates yes |
Detailed Description¶
» protocolType: indicates TCP indicates UDP
» proxyProtocol: off：indicates disabled on：indicates enabled
Response Example
200 Response
201 Response
Responses¶
| Status Code | Status Meaning | Description | Data Model |
|---|---|---|---|
| 200 | OK | none | Inline |
| 201 | Created | none | Inline |
| 401 | Unauthorized | none | Inline |
| 403 | Forbidden | none | Inline |
| 404 | Not Found | none | Inline |
Response Data Structure¶
Status Code 200
| Name | Type | Required | Constraints | Chinese Name | Description |
|---|---|---|---|---|---|
| » msg | string | true | none | none | |
| » code | integer | true | none | none |
Data Model¶
Layer4RuleVO
{
"hyPort": "string",
"limitConn": 0,
"listenPort": "string",
"node": "string",
"originAddress": "string",
"protocolType": "string",
"proxyProtocol": "string",
"remark": "string",
"ruleId": 0,
"types": "string"
}
Layer4RuleVO
Properties¶
| Name | Type | Required | Constraints | Chinese Name | Description |
|---|---|---|---|---|---|
| hyPort | string | true | none | Forwarding Port | none |
| limitConn | integer(int32) | false | none | Rate Limiting | none |
| listenPort | string | true | none | Origin Port | none |
| node | string | true | none | Instance | none |
| originAddress | string | true | none | Origin Address | Multiple addresses separated by semicolons (;) |
| protocolType | string | true | none | orwarding Protocol | indicates TCP indicates UDP |
| proxyProtocol | string | true | none | proxy_protocol | off：indicates disabled on：indicates enabled |
| remark | string | false | none | none | |
| ruleId | integer(int64) | false | none | Rule ID | none |
| types | string | true | none | Session Persistence | off: indicates no; on: indicates yes |