拉取转发规则列表

最近更新时间: 2026-09-17 00:04:36

1. 接口描述

接口请求域名： vpcdns.api3.fincloud.tencent.cn。

拉取转发规则列表

默认接口请求频率限制：20次/秒。

接口更新时间：2025-06-24 04:58:19。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeForwardRuleList
Version	是	否	String	公共参数，本接口取值：2019-10-25
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Filters	否	否	Array of RuleListFilters	域名DomainName, 转发ip ForwardIp, 私有域ID DomainId 示例值：查看
Offset	是	否	Int64	偏移示例值： 0
Limit	是	否	Int64	长度示例值： 20

3. 输出参数

参数名称	类型	描述
Total	Int64	总数示例值： 3
ForwardRuleList	Array of ForwardRuleList	转发规则列表示例值：查看
CreatedAt	Datetime	请求响应时间示例值： 2014-08-03 12:00:00
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameterValue.	参数值错误
InternalError.UndefiendError	错误未定义
InvalidParameter.	参数错误

5. 示例

示例1 成功获取转发规则列表

输入示例

{
  "Filters": [
    {
      "Name": "DomainName",
      "Values": [
        "test"
      ]
    }
  ],
  "Limit": 20,
  "Offset": 0
}

输出示例

{
  "Response": {
    "RequestId": "d6a71bcf-b37f-41b3-7aa3-c98fff68fd60",
    "CreatedAt": "2025-06-23 12:57:45",
    "Total": 3,
    "ForwardRuleList": [
      {
        "DomainId": "75",
        "DomainName": "test3.com",
        "RuleId": "48",
        "ForwardAddress": [
          "1.2.3.1:80",
          "2.38.1.2:80"
        ],
        "Remark": "vpcdnss_test",
        "VpcInfos": [],
        "CreatedOn": "2025-06-23T12:56:19.000000Z",
        "UpdatedOn": "2025-06-23T12:56:19.000000Z"
      },
      {
        "DomainId": "71",
        "DomainName": "test.com",
        "RuleId": "46",
        "ForwardAddress": [
          "1.2.3.1:80",
          "11.2.3.1:80"
        ],
        "Remark": "vpcdnss_test",
        "VpcInfos": [],
        "CreatedOn": "2025-06-23T12:52:25.000000Z",
        "UpdatedOn": "2025-06-23T12:52:25.000000Z"
      },
      {
        "DomainId": "47",
        "DomainName": "test.com",
        "RuleId": "39",
        "ForwardAddress": [
          "10.1.1.1:80",
          "10.1.1.2:80"
        ],
        "Remark": "5",
        "VpcInfos": [
          {
            "un_vpc_id": "vpc-b9e4y9ep",
            "vpc_id": 67369,
            "region_id": 50000001
          },
          {
            "un_vpc_id": "vpc-d4g487mp",
            "vpc_id": 65576,
            "region_id": 50000001
          }
        ],
        "CreatedOn": "2025-02-11T09:25:55.000000Z",
        "UpdatedOn": "2025-02-11T09:25:55.000000Z"
      }
    ]
  }
}