ConfigLayer4Remark - Anti-DDoS - Alibaba Cloud Documentation Center

Adds a description to a port forwarding rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:ConfigLayer4Remark	update	All Resources *	none	none

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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6E46CC51-36BE-1100-B14C-DAF8381B8F73

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-14	The internal configuration of the API is changed, but the call is not affected	View Change Details