DescribeNetworkRules - Anti-DDoS - Alibaba Cloud Documentation Center

Queries port forwarding rules.

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	Association operation
yundun-ddoscoo:DescribeNetworkRules	Read	DdosCoo acs:yundun-ddoscoo:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. NoteYou 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 parameters

Parameter	Type	Description	Example
	object
TotalCount	long	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	An array that consists of the details of a port forwarding rule.
	object
FrontendPort	integer	The forwarding port.	80
IsAutoCreate	boolean	Indicates whether the port forwarding rule is automatically created. Valid values: true: yes false: no	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	An array that consists of IP addresses of origin servers.
	string	The IP address of the origin server.	112.139.XX.XX

Examples

Sample success responses

JSONformat

{
  "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"
      ]
    }
  ]
}

Error codes

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