查询转发规则列表

最近更新时间:2025-10-16 02:21:41

我的收藏

1. 接口描述

接口请求域名: privatedns.tencentcloudapi.com 。

查询转发规则列表

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeForwardRuleList。
Version String 公共参数,本接口取值:2020-10-28。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页偏移量,从0开始
示例值:1
Limit Integer 分页限制数目, 最大100,默认20
示例值:10
Filters.N Array of Filter 过滤参数

3. 输出参数

参数名称 类型 描述
TotalCount Integer 私有域数量
示例值:10
ForwardRuleSet Array of ForwardRule 私有域列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取私有域列表

输入示例

POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeForwardRuleList
<公共请求参数>

{
    "Limit": 200,
    "Offset": 0,
    "Filters": [
        {
            "Name": "RuleName",
            "Values": [
                "呵呵"
            ]
        },
        {
            "Name": "RuleType",
            "Values": [
                "DOWN"
            ]
        },
        {
            "Name": "ZoneId",
            "Values": [
                "zone-04jlawty"
            ]
        },
        {
            "Name": "EndPointId",
            "Values": [
                "eid-asdfadaf"
            ]
        },
        {
            "Name": "EndPointName",
            "Values": [
                "zdjdhhh"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "8a4ea9cc-b1df-f8f8-ffe7efbe98f9ff85",
        "TotalCount": 5,
        "ForwardRuleSet": [
            {
                "Domain": "qq.com",
                "ZoneId": "zone-s8cs72d9",
                "RuleId": "fid-af2skm96n",
                "ForwardAddress": [
                    "1.1.1.1:53"
                ],
                "RuleType": "UP",
                "VpcSet": [
                    {
                        "Region": "ap-guangzhou",
                        "UniqVpcId": "vpc-dus89eks"
                    }
                ],
                "EndPointName": "终端节点1",
                "EndPointId": "eid-fxiuf872bsp",
                "RuleName": "转发规则名称",
                "UpdatedAt": "2022-09-09 10:45:44",
                "CreatedAt": "2022-09-09 10:45:44",
                "Tags": [
                    {
                        "TagKey": "region",
                        "TagValue": "ap-guangzhou"
                    }
                ]
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.UndefiendError 错误未定义。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound.ServiceNotSubscribed 私有域解析服务未开通。
UnauthorizedOperation.UnauthorizedAccount 未实名账号。
UnknownParameter 未知参数错误。