查询转发规则

最近更新时间:2024-11-08 01:56:15

我的收藏

1. 接口描述

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

查询转发规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeForwardRule。
Version String 公共参数,本接口取值:2020-10-28。
Region String 公共参数,本接口不需要传递此参数。
RuleId String 转发规则ID
示例值:fid-afdsf23s

3. 输出参数

参数名称 类型 描述
ForwardRule ForwardRule 转发规则详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询转发规则

输入示例

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

{
    "RuleId": "fid-af2f9nkug"
}

输出示例

{
    "Response": {
        "RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
        "ForwardRule": {
            "Domain": "qq.com",
            "ZoneId": "zone-s8cs72d9",
            "RuleId": "fid-fa2c8misu",
            "ForwardAddress": [
                "1.1.11.1:53"
            ],
            "RuleType": "DOWN",
            "VpcSet": [
                {
                    "Region": "ap-guangzhou",
                    "UniqVpcId": "vpc-as3bsfml"
                }
            ],
            "EndPointName": "终端节点名",
            "EndPointId": "eid-fc9iuxhg4",
            "RuleName": "转发规则名称",
            "UpdatedAt": "2022-09-09 10:45:44",
            "CreatedAt": "2022-09-09 10:45:44"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.UndefiendError 错误未定义。
InvalidParameter 参数错误。
InvalidParameter.EndPointBindForwardRule 终端节点已经绑定了转发规则。
InvalidParameter.ForwardRuleNotExist 转发规则不存在。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnsupportedOperation.FrequencyLimit 接口调用超过限频。