调用DescribePort查询端口转发规则_DDoS防护(Anti-DDoS)-阿里云帮助中心

查询DDoS高防实例下已创建的端口转发规则。

接口说明

本接口支持与 Terraform 工具对接。关于 Terraform 的更多信息，请参见什么是 Terraform。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-ddoscoo:DescribePort	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	要查询的 DDoS 高防实例的 ID。说明您可以调用 DescribeInstanceIds 查询所有 DDoS 高防实例的 ID。	ddoscoo-cn-7e225i41****
FrontendProtocol	string	否	要查询的转发协议类型。取值： tcp：表示 TCP 协议。 udp：表示 UDP 协议。	tcp
FrontendPort	integer	否	要查询的转发端口。取值范围：0~65535。	55
PageNumber	integer	是	分页查询时返回的页码。例如，查询第一页的返回结果，则设置 1。	1
PageSize	integer	是	分页查询时每页包含的记录数量。	10

返回参数

名称	类型	描述	示例值
	object
TotalCount	long	返回的端口转发规则的数量。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	39499F01-19D9-4EA4-A0E9-C6014BA5CDBE
NetworkRules	object []	端口转发规则配置列表。
FrontendPort	integer	转发端口。	55
IsAutoCreate	boolean	该规则是否由 DDoS 高防自动生成。取值： true：表示由 DDoS 高防自动生成。 false：表示由您手动创建。	false
InstanceId	string	转发规则所属的 DDoS 高防实例的 ID。	ddoscoo-cn-7e225i41****
FrontendProtocol	string	转发协议类型。取值： tcp：表示 TCP 协议。 udp：表示 UDP 协议。	tcp
BackendPort	integer	源站端口。	55
RealServers	array	源站 IP 地址列表。
	string	源站 IP 地址。	1.XX.XX.1

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。