DescribePort - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the port forwarding rules that are created for an Anti-DDoS Pro or Anti-DDoS Premium instance.

Operation description

You can call this operation by using Terraform. For more information about Terraform, see What is Terraform?.

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.

Debug

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	Associated operation
yundun-ddoscoo:DescribePort	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-7e225i41****
FrontendProtocol	string	No	The type of the forwarding protocol to query. Valid values: tcp udp	tcp
FrontendPort	integer	No	The forwarding port to query. Valid values: 0 to 65535.	55
PageNumber	integer	No	The page number. For example, if you want to obtain results on the first page, set the value to 1.	1
PageSize	integer	No	The number of entries per page.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The number of port forwarding rules returned.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	39499F01-19D9-4EA4-A0E9-C6014BA5CDBE
NetworkRules	array<object>	An array that consists of port forwarding rules.
NetworkRule	object
FrontendPort	integer	The forwarding port.	55
IsAutoCreate	boolean	Indicates whether the port forwarding rule is automatically created by the instance. Valid values: true: yes false: no	false
InstanceId	string	The ID of the instance to which the port forwarding rule is applied.	ddoscoo-cn-7e225i41****
FrontendProtocol	string	The type of the protocol. Valid values: tcp udp	tcp
BackendPort	integer	The port of the origin server.	55
RealServers	array	An array that consists of IP addresses of origin servers.
RealServers	string	The IP address of the origin server.	1.XX.XX.1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "39499F01-19D9-4EA4-A0E9-C6014BA5CDBE",
  "NetworkRules": [
    {
      "FrontendPort": 55,
      "IsAutoCreate": false,
      "InstanceId": "ddoscoo-cn-7e225i41****",
      "FrontendProtocol": "tcp",
      "BackendPort": 55,
      "RealServers": [
        "1.XX.XX.1"
      ]
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-30	The internal configuration of the API is changed, but the call is not affected	View Change Details