All Products
Search
Document Center

Anti-DDoS:ConfigLayer4Remark

Last Updated:Feb 25, 2026

Adds a description to a port forwarding rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

Listeners

string

Yes

The port forwarding rule that you want to manage.

This parameter is a string that consists of JSON arrays. Each element in a JSON array indicates a port forwarding rule. You can perform this operation only on one port forwarding rule at a time.

Note

You can call the DescribeNetworkRules to query existing port forwarding rules.

Each port forwarding rule contains the following fields:

  • InstanceId: the ID of the instance. This field is required and must be of the STRING type.

  • Protocol: the forwarding protocol. This field is required and must be of the STRING type. Valid values: tcp and udp.

  • FrontendPort: the forwarding port. This field is required and must be of the INTEGER type.

  • Remark: the remarks of the port forwarding rule. This field is required and must be of the STRING type. The value can contain letters, digits, and some special characters, such as , . + - * / _. The value can be up to 200 characters in length.

[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\",\"Remark\":\"test\"}]

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

6E46CC51-36BE-1100-B14C-DAF8381B8F73

Examples

Success response

JSON format

{
  "RequestId": "6E46CC51-36BE-1100-B14C-DAF8381B8F73"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.