添加转发规则--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

添加转发规则

最近更新时间：2024.05.29 18:51:25首次发布时间：2023.06.26 20:59:38

API 说明

API 名称：CreateResolverRule。
API 域名：open.volcengineapi.com。
API 描述：添加一条转发规则。

请求方法

POST

请求参数

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

参数名称	数据类型	参数类型	是否必选	参数说明
Action	String	查询参数	是	API 的名称。该参数的取值是 `CreateResolverRule`。
Version	String	查询参数	是	API 的版本。该参数的取值是 `2022-06-01`。
Name	String	请求正文参数	是	转发规则的名称。支持 UTF-8 格式。
Type	String	请求正文参数	是	转发规则类型。 `OUTBOUND`：转发到外部的 DNS 服务器。 `LINE`：把递归解析所使用的递归 DNS 服务器设置为火山引擎公共解析（PublicDNS）的递归 DNS 服务器，并自定义递归 DNS 服务器的出口 IP 地址的运营商。
ZoneName	String	请求正文参数	否	转发规则所关联的域名。您可以输入一个或多个域名。多个域名之间使用英文逗号 `,` 分隔，例如 `example.com,volcengine.com`。最多支持输入 500 个域名。该参数仅在 `Type` 参数是 `OUTBOUND` 时有效且为必选参数。
EndpointID	Integer	请求正文参数	否	终端节点的 ID。该参数仅在 `Type` 参数是 `OUTBOUND` 时有效且为必选参数。
ForwardIPs	Array of Objects	请求正文参数	否	外部的 DNS 服务器的 IP 地址和端口。您最多只能添加 10 个 IP 地址。该参数仅在 `Type` 参数是 `OUTBOUND` 时有效且为必选参数。
Line	Integer	请求正文参数	否	递归 DNS 服务器的出口 IP 地址的运营商。该参数仅在 `Type` 参数是 `LINE` 时有效且为必选参数。 MOBILE：移动。 TELECOM：电信。 UNICOM：联通。
VPCs	Array of Objects	请求正文参数	是	转发规则所关联的 VPC。`Type` 参数是 `OUTBOUND` 时，VPC 的地域必须和终端节点所在的地域相同。

响应正文

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

示例

请求示例

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

{
  "Name": "testRule",
  "Type": "OUTBOUND",
  "ZoneName": "test.com",
  "EndpointID": 2344,
  "ForwardIPs": [
    {
      "IP": "xxx.xxx.xxx.xxx"
    }
  ],
  "VPCs": [
    {
      "cn-beijing": [
        "vpc-2750bd1"
      ]
    }
  ]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230614140553EC822FFD341E9C19EF59",
        "Action": "CreateResolverRule",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },

    "Result": {
    	  "RuleID": 123
    }
     
}