You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/私网解析 PrivateZone/API 参考/解析器 Resolver 接口/CreateResolverRule-添加转发规则
CreateResolverRule-添加转发规则
最近更新时间：2024.11.20 11:13:11首次发布时间：2023.06.26 20:59:38
我的收藏

添加一条转发规则。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=CreateResolverRule?Version=2022-06-01

请求参数

除了以下参数，您还需要 对请求进行鉴权。

Query

名称
类型
是否必选
示例值
描述
Action
String
是
CreateResolverRule
API 的名称。该参数的取值是 CreateResolverRule。
Version
String
是
2022-06-01
API 的版本。该参数的取值是 2022-06-01。

Body

名称
类型
是否必选
示例值
描述
Name
String
是
rule01
转发规则的名称。支持 UTF-8 格式。
Type
String
是
OUTBOUND
转发规则类型。
  • OUTBOUND：转发到外部的 DNS 服务器。
  • LINE：自定义公网递归 DNS 服务器的出口 IP 地址的运营商。
ZoneName
String
否
example.com
转发规则所关联的域名。您可以输入一个或多个域名。多个域名之间使用英文逗号 , 分隔，例如 example.com,volcengine.com。最多支持输入 500 个域名。该参数仅在 Type 参数是 OUTBOUND 时有效且为必选参数。如果您把该参数设置为 *，则转发规则适用于 VPC 关联的所有域名。
EndpointID
Integer
否
1234
终端节点的 ID。该参数仅在 Type 参数是 OUTBOUND 时有效且为必选参数。
ForwardIPs
Array of Objects
否
外部的 DNS 服务器的 IP 地址和端口。您最多只能添加 10 个 IP 地址。该参数仅在 Type 参数是 OUTBOUND 时有效且为必选参数。
Line
String
否
联通
公网递归 DNS 服务器的出口 IP 地址的线路。该参数仅在 Type 参数是 LINE 时有效且为必选参数。该参数必须是您调用 ListRecursiveLines API 获取的线路列表中的一条线路。
VPCs
Array of Objects
是
{"cn-beijing":["vpc-2d6si87atfh1c58ozfd0nzq8k"]}
转发规则所关联的 VPC。转发规则在关联的 VPC 中生效。Type 参数是 OUTBOUND 时，VPC 的地域必须和终端节点所在的地域相同。
ProjectName
String
否
default
转发规则所属的项目名称。默认为 default。
VpcTrns
Array of strings
否
["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]
域名所关联的一个或多个 VPC 的 TRN。格式为 trn:vpc:region:accountId:vpc/vpcId。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
Tags
Array of objects
否
[{"Key":"key1", "Value":"value1"},{"Key":"key2", "Value":"value2"}]
转发规则所属的一个或多个标签。一个资源最多能关联 50 个标签。
EndpointTrn
String
否
trn:private_zone::21******4::endpoint/ep-1234
终端节点的 TRN。格式为 trn:private_zone::accountId::endpoint/ep-endpointId。如果您需要验证子用户是否对终端节点所在的项目有操作权限，您需要传入该参数。

返回参数

ResponseMetadata 对象

名称
类型
描述
RequestId
String
标识本次请求的 ID。
Action
String
Action 查询参数的值。
Version
String
API 版本。
Service
String
服务类型。
Region
String
服务所在地域。

Result 对象

参数名称
数据类型
参数说明
RuleID
Integer
转发规则的 ID。

示例

请求示例

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

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

返回示例

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

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

错误码

您可访问公共错误码，获取详细信息。