QueryResolverRule - 获取转发规则详细信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

QueryResolverRule - 获取转发规则详细信息

最近更新时间：2025.05.22 21:08:45首次发布时间：2023.06.26 20:59:38

获取一条转发规则的详细信息。

使用说明

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

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=QueryResolverRule?Version=2022-06-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryResolverRule	要执行的操作，取值：QueryResolverRule。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
RuleID	Long	是	123456	转发规则的 ID。您可以从以下 API 的响应中获取： CreateResolverRule ListResolverRules
RuleTrn	String	否	trn:private_zone::21******4::rule/rule-1234	转发规则的 TRN。格式为 `trn:private_zone::accountId::rule/rule-ruleId`。如果您需要验证子用户是否对转发规则所在的项目有操作权限，您需要传入该参数。

返回参数

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

参数	类型	示例值	描述
ID	Long	123	转发规则的 ID。转发规则的 ID。
CreatedAt	String	2023-06-16T11:18:10+08:00	转发规则的创建时间。
UpdatedAt	String	2023-06-16T11:18:10+08:00	转发规则的更新时间。
Name	String	testRule	转发规则的名称。
Type	String	OUTBOUND	转发规则类型。
ZoneName	String	example.com	转发规则所关联的域名。
EndpointID	Integer	123	出站终端节点的 ID。该参数仅在转发规则类型是 `OUTBOUND` 时才会被返回。
ForwardIPs	Array of Object	无	VPC 外部的 DNS 服务器的 IP 地址和端口。该参数仅在转发规则类型是 OUTBOUND 时才会被返回。
Line	String	MOBILE	递归 DNS 服务器的出口 IP 地址的运营商。该参数仅在转发规则类型是 LINE 时才会被返回。
BindVPCs	Array of Object	无	转发规则所关联的 VPC。
Enable	Boolean	true	转发规则是否被启用。 true：启用。 false：禁用。
LastOperator	String	21000001	最近一次更新转发规则的火山引擎账号的 ID。
ProjectName	String	default	转发规则所属的项目名称。
Tags	Array of Object	无	转发规则所属的一个或多个标签。

请求示例

POST https://private-zone.volcengineapi.com/?Action=QueryResolverRule&Version=2022-06-01&RuleID=123456

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230616145641EA5B5D03C58060E30F62",
    "Action": "QueryResolverRule",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-north-1"
  },
  "Result": {
    "ID": 87,
    "CreatedAt": "2023-06-16T11:18:10+08:00",
    "UpdatedAt": "2023-06-16T11:18:10+08:00",
    "Name": "testRule",
    "Type": "OUTBOUND",
    "ZoneName": "test.com",
    "EndpointID": 238,
    "ForwardIPs": [
      {
        "IP": "xxx.xxx.xxx.xxx",
        "Port": 1
      },
      {
        "IP": "xxx.xxx.xxx.xxx",
        "Port": 3
      },
      {
        "IP": "xxx.xxx.xxx.xxx",
        "Port": 2
      }
    ],
    "BindVPCs": [
      {
        "ID": "vpc-2bzixxxxxg2dx0eg3ur0cv",
        "Region": "华北2（北京）",
        "RegionName": "cn-beijing",
        "AccountID": "210xxxx597"
      }
    ],
    "Enable": true,
    "LastOperator": "210xxxx597",
    "ProjectName": "default",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrRuleNotFound	resolver rule not found	未找到转发规则
500	ErrInternalServer	server internal error	服务内部错误