Adds remarks for a port forwarding rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ConfigLayer4Remark

The operation that you want to perform. Set the value to ConfigLayer4Remark.

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

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.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance.

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 Example Description
RequestId String 6E46CC51-36BE-1100-B14C-DAF8381B8F73

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ConfigLayer4Remark
&Listeners=[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"FrontendPort\":2020,\"Protocol\":\"udp\",\"Remark\":\"test\"}]
&<Common request parameters>

Sample success responses

XML format

<ConfigLayer4RemarkResponse>
	  <RequestId>6E46CC51-36BE-1100-B14C-DAF8381B8F73</RequestId>
</ConfigLayer4RemarkResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.