All Products
Search
Document Center

Anti-DDoS:DescribeNetworkRules

Last Updated:Feb 06, 2023

Queries port forwarding rules.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
yundun-ddoscoo:DescribeNetworkRulesRead
  • DdosCoo
    acs:yundun-ddoscoo:{#regionId}:{#accountId}:*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

Note: You can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-mp91j1ao****
ForwardProtocolstringNo

The forwarding protocol. Valid values:

  • tcp
  • udp
tcp
FrontendPortintegerNo

The forwarding port.

80
PageNumberintegerYes

The number of the page to return. For example, to query the returned results on the first page, set the value to 1.

1
PageSizeintegerYes

The number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of returned port forwarding rules.

1
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

8597F235-FA5E-4FC7-BAD9-E4C0B01BC771
NetworkRulesarray

An array that consists of the details of a port forwarding rule.

object
FrontendPortinteger

The forwarding port.

80
IsAutoCreateboolean

Indicates whether the port forwarding rule is automatically created. Valid values:

  • true: yes
  • false: no
true
InstanceIdstring

The ID of the instance.

ddoscoo-cn-mp91j1ao****
Protocolstring

The forwarding protocol. Valid values:

  • tcp
  • udp
tcp
BackendPortinteger

The port of the origin server.

80
RealServersarray

An array that consists of the IP addresses of the origin server.

string

The IP address of the origin server.

112.139.XX.XX

Example

Normal return example

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 API error center.