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

文档中心

立即注册

TrafficRoute DNS 套件

解析器Resolver

CreateResolverRule - 添加转发规则

添加一条转发规则。

使用说明

请求频率：每秒最多调用 10 次。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateResolverRule	要执行的操作，取值：CreateResolverRule。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ProjectName	String	否	default	转发规则所属的项目名称。默认为 default。
VpcTrns	Array of String	否	["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]	域名所关联的一个或多个 VPC 的 TRN。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
EndpointID	Integer	否	1234	终端节点的 ID。该参数仅在 `Type` 参数是 `OUTBOUND` 时有效且为必选参数。您可以从以下 API 的响应中获取： CreateResolverEndpoint ListResolverEndpoints
EndpointTrn	String	否	trn:private_zone::21******4::endpoint/ep-1234	终端节点的 TRN。格式为 `trn:private_zone::accountId::endpoint/ep-endpointId`。如果您需要验证子用户是否对终端节点所在的项目有操作权限，您需要传入该参数。
Tags	Array of Object	否	[{"Key":"key1", "Value":"value1"},{"Key":"key2", "Value":"value2"}]	转发规则所属的一个或多个标签。一个资源最多能关联 50 个标签。
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 关联的所有域名。
ForwardIPs	Array of Object	是	无	外部的 DNS 服务器的 IP 地址和端口。您最多只能添加 10 个 IP 地址。该参数仅在 Type 参数是 OUTBOUND 时有效且为必选参数。
Line	String	否	移动	递归 DNS 服务器的出口 IP 地址的运营商。该参数仅在 `Type` 参数是 `LINE` 时有效。支持的取值： - `移动`：中国移动 - `电信`：中国电信 - `联通`：中国联通
Vpcs	Array of Object	是	无	转发规则所关联的 VPC。转发规则在关联的 VPC 中生效。`Type` 参数是 `OUTBOUND` 时，VPC 的地域必须和终端节点所在的地域相同。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
RuleID	Long	123	转发规则的 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": [
    {
      "VpcId": "vpc-2d6si87atfh1c58ozfd0nzq8k",
      "Region": "cn-beijing"
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250520150849192186202142D46131",
    "Action": "CreateResolverRule",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-beijing"
  },
  "Result": {
    "RuleID": 179
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrVPCCountLimited	vpc count limited when binding zone	关联VPC数量超出限制
400	ErrNoVPCSpecified	at least one vpc should be specified	未关联VPC
400	ErrRegionNotSupport	%s of [%s] not supported by private_zone	private_zone不支持[%s]地域的%s
409	ErrVPCUniqKey	zone already exists in vpc-13fa58mongp343n6nu59bneye	VPC 不能关联重复的域名
500	ErrInternalServer	server internal error	服务内部错误

最近更新时间：2025.09.22 16:33:59

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #