You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取转发规则列表

最近更新时间：2023.12.15 10:24:16

首次发布时间：2023.06.26 20:59:38

我的收藏

API 说明

API 名称：ListResolverRules。
API 域名：open.volcengineapi.com。
API 描述：获取转发规则的列表。

火山引擎私网解析（PrivateZone）可以通过解析器（Resolver）把火山引擎私有网络（VPC）内的 DNS 请求转发到 VPC 外部的 DNS 服务器。参见 使用解析器转发 DNS 请求。

请求方法

GET

请求参数

除了以下参数，您还需要在请求头中指定 请求方法 并包含 签名参数。

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 ListResolverRules。
VersionString查询参数是API 的版本。该参数的取值是 2022-06-01。
NameString查询参数是转发规则的名称。
ZoneNameString查询参数是转发规则所关联的主域名。例如，您把该参数设置为 example.com，则对 example.com 以及 example.com 的所有子域名的 DNS 请求都会被转发。
EndpointIDInteger查询参数是出站终端节点的 ID。
PageNumberInteger查询参数是页码。页数由获取的出站终端节点总数和 PageSize 确定。默认为 1。
PageSizeInteger查询参数是每页包含的出站终端节点的数量。默认为 10。返回结果会将获取的出站终端节点进行分页显示。页数由获取的出站终端节点总数和 PageSize 确定。

响应正文

参数名称
数据类型
参数说明
ResponseMetadata
Object
响应的元数据。
Result
Object
响应结果。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListResolverRules&Version=2022-06-01

响应示例

{
  "ResponseMetadata": {
    "RequestId": "20230616155126FE7F678484114BA650D8",
    "Action": "ListResolverRules",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-north-1"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 20,
    "Total": 1,
    "Rules": [
      {
        "ID": 86,
        "CreatedAt": "2023-06-16T11:10:43+08:00",
        "UpdatedAt": "2023-06-16T11:13:38+08:00",
        "Name": "testRule",
        "Type": "OUTBOUND",
        "ZoneName": "test.com",
        "EndpointID": 238,
        "ForwardIPs": [
          {
            "IP": "xxx.xxx.xxx.xxx",
            "Port": 1
          }
        ]
      }
    ]
  }
}