All Products
Search

This Product

    Anti-DDoS:ConfigLayer4RulePolicy

    Document Center

    Anti-DDoS:ConfigLayer4RulePolicy

    Last Updated:Oct 23, 2024

    Configures the IP addresses of the primary and secondary origin servers for 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-ddoscoo:ConfigLayer4RulePolicyupdate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ListenersstringYes

    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.

    • BackendPort: the port of the origin server. This field is required and must be of the INTEGER type.

    • PriRealServers: the IP addresses of the primary origin server. This field is required and must be a JSON array. Each element in a JSON array indicates an IP address of the primary origin server. You can configure a maximum of 20 IP addresses.

      Each element in the JSON array contains the following field:

      • RealServer: the IP address of the primary origin server. This field is required and must be of the STRING type.

    • SecRealServers: the IP addresses of the secondary origin server. This field is required and must be a JSON array. Each element in a JSON array indicates an IP address of the secondary origin server. You can configure a maximum of 20 IP addresses.

      Each element in the JSON array contains the following field:

      • RealServer: the IP address of the secondary origin server. This field is required and must be of the STRING type.

    • CurrentRsIndex: the origin server that you want to use to receive service traffic. This field is required and must be of the INTEGER type. Valid values:

      • 1: the primary origin server, which indicates that Anti-DDoS Pro or Anti-DDoS Premium forwards service traffic to the IP addresses of the primary origin server.
      • 2: the secondary origin server, which indicates that Anti-DDoS Pro or Anti-DDoS Premium forwards service traffic to the IP addresses of the secondary origin server.
    		[{\"InstanceId\":\"ddosDip-sg-4hr2b3l****\",\"Protocol\":\"udp\",\"FrontendPort\":2020,\"BackendPort\":2022,\"PriRealServers\":[{\"RealServer\":\"192.0.2.1\"},{\"RealServer\":\"192.0.2.2\"}],\"SecRealServers\":[{\"RealServer\":\"192.0.2.3\"},{\"RealServer\":\"192.0.2.4\"}],\"CurrentRsIndex\":1}]

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		CC042262-15A3-4A49-ADF0-130968EA47BC

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "CC042262-15A3-4A49-ADF0-130968EA47BC"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-05-14The internal configuration of the API is changed, but the call is not affectedView Change Details