DescFwdRule - 查询端口转发规则--DDoS防护-火山引擎

文档中心

立即注册

导航

DescFwdRule - 查询端口转发规则

最近更新时间：2024.05.29 11:03:22首次发布时间：2024.05.20 21:52:14

按特定协议或端口号查询对应实例下的端口转发规则。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescFwdRule&Version=2021-06-15

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescFwdRule	要执行的操作，取值：DescFwdRule。
Version	String	是	2021-06-15	API的版本，取值：2021-06-15。
Proto	String	否	tcp	转发协议，包括以下两种： tcp udp
Port	Integer	否	0	转发端口。输入 0 则表示所有端口。
CurrPage	Integer	否	1	当前展示页码，默认为 1。
PageSize	Integer	否	20	每个页面展示的数量。默认为 10000。
FwdSortBy	String	否	dstProtoPort	排序标准，当前支持：转发协议+端口: dstProtoPort 源站协议+端口: srcProtoPort 按创建时间降序：留空
FwdSortDesc	Integer	否	0	是否降序排列，默认为升序。 1 ：降序 0 ：升序
InstanceIp	String	是	1.1.1.1	待查询的实例 IP。
Labels	Array of String	否	规则组1	标签备注信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Result	Result	--	端口规则查询详情。
PageInfo	PageInfo	--	分页信息。

请求示例

POST /?Action=DescFwdRule&Version=2021-06-15 HTTP/1.1&InstanceIp=163.177.***.***
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240513T131645Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240513/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405201935363E804227E4296BA9****",
        "Action": "DescFwdRule",
        "Version": "2021-06-15",
        "Service": "AdvDefence",
        "Region": "cn-beijing"
    },
    "Result": {
        "Count": 3,
        "RemainCount": 57,
        "FwdRules": [
            {
                "Id": 7954,
                "InstanceIp": "163.177.***.***",
                "Proto": "tcp",
                "FwdPort": 488,
                "SrcPort": 488,
                "Type": 1,
                "SrcIpList": [
                    "1.1.2.3"
                ],
                "Status": 100,
                "CreateFrom": 1,
                "Timeout": 90,
                "Labels": [
                    "BeShine"
                ]
            },
            {
                "Id": 7953,
                "InstanceIp": "163.177.***.***",
                "Proto": "tcp",
                "FwdPort": 466,
                "SrcPort": 466,
                "Type": 1,
                "SrcIpList": [
                    "1.1.2.3"
                ],
                "Status": 100,
                "CreateFrom": 1,
                "Timeout": 90,
                "Labels": [
                    "BeShine"
                ]
            },
            {
                "Id": 7950,
                "InstanceIp": "163.177.***.***",
                "Proto": "tcp",
                "FwdPort": 445,
                "SrcPort": 445,
                "Type": 1,
                "SrcIpList": [
                    "1.1.1.1"
                ],
                "Status": 100,
                "CreateFrom": 1,
                "Timeout": 90,
                "Labels": []
            }
        ]
    },
    "PageInfo": {
        "TotalCount": 3,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 3
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	1	请求内容/参数错误，请检查请求内容/参数格式。	请求体校验失败。请求参数校验失败。
200	2	内部错误，请重试或联系服务提供者。	服务操作失败。
200	10	内部错误，请重试或联系服务提供者。	状态异常。