DescribeNetworkRules

Queries port forwarding rules.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddoscoo:DescribeNetworkRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-mp91j1ao****
ForwardProtocol	string	No	The forwarding protocol. Valid values: tcp udp	tcp
FrontendPort	integer	No	The forwarding port.	80
PageNumber	integer	Yes	The number of the page to return. For example, to query the returned results on the first page, set the value to 1.	1
PageSize	integer	Yes	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of returned port forwarding rules.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	8597F235-FA5E-4FC7-BAD9-E4C0B01BC771
NetworkRules	array<object>	The details of the port forwarding rules.
	object
FrontendPort	integer	The forwarding port.	80
IsAutoCreate	boolean	Indicates whether the port forwarding rule is automatically created. Valid values: true false	true
InstanceId	string	The ID of the instance.	ddoscoo-cn-mp91j1ao****
Protocol	string	The forwarding protocol. Valid values: tcp udp	tcp
BackendPort	integer	The port of the origin server.	80
RealServers	array	The IP addresses of origin servers.
	string	The IP address of the origin server.	112.139.XX.XX
Remark	string	The remarks of the port forwarding rule.	Test
ProxyEnable	integer	Indicates whether the traffic diversion switch is on. Valid values: 0: on. 1: off.	0
ProxyStatus	string	The status of traffic diversion. Valid values: on: Traffic diversion takes effect. off: Traffic diversion does not take effect.	on
PayloadRuleEnable	integer	Indicates whether the payload filtering rule is enabled. Valid values: 1: enabled. 0: disabled.	1

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "8597F235-FA5E-4FC7-BAD9-E4C0B01BC771",
  "NetworkRules": [
    {
      "FrontendPort": 80,
      "IsAutoCreate": true,
      "InstanceId": "ddoscoo-cn-mp91j1ao****",
      "Protocol": "tcp",
      "BackendPort": 80,
      "RealServers": [
        "112.139.XX.XX"
      ],
      "Remark": "Test",
      "ProxyEnable": 0,
      "ProxyStatus": "on",
      "PayloadRuleEnable": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.