You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/私网解析 PrivateZone/API 参考/解析器 Resolver 接口/QueryResolverRule-获取转发规则详细信息
QueryResolverRule-获取转发规则详细信息
最近更新时间：2024.12.10 10:36:52首次发布时间：2023.06.26 20:59:38
我的收藏

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

请求说明

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

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是QueryResolverRuleAPI 的名称。该参数的取值是 QueryResolverRule。
VersionString是2022-06-01API 的版本。该参数的取值是 2022-06-01。
RuleIDInteger是123456转发规则的 ID。
RuleTrnString否trn:private_zone::21******4::rule/rule-1234转发规则的 TRN。格式为 trn:private_zone::accountId::rule/ep-ruleId。如果您需要验证子用户是否对转发规则所在的项目有操作权限，您需要传入该参数。

返回参数

ResponseMetadata 对象

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

Result 对象

名称
类型
描述
ID
Integer
转发规则的 ID。
CreatedAt
String
转发规则的创建时间。
UpdatedAt
String
转发规则的更新时间。
Name
String
转发规则的名称。
Type
String
转发规则类型。
ZoneName
String
转发规则所关联的域名。
EndpointID
Integer
出站终端节点的 ID。该参数仅在转发规则类型是 OUTBOUND 时才会被返回。
ForwardIPs
Array of Objects
VPC 外部的 DNS 服务器的 IP 地址和端口。该参数仅在转发规则类型是 OUTBOUND 时才会被返回。
Line
Integer
递归 DNS 服务器的出口 IP 地址的运营商。该参数仅在转发规则类型是 LINE 时才会被返回。
BindVPCs
Array of Objects
转发规则所关联的 VPC。
Enable
Boolean
转发规则是否被启用。
  • true：启用。
  • false：禁用。
LastOperator
String
最近一次更新转发规则的火山引擎账号的 ID。
ProjectName
String
转发规则所属的项目名称。
Tags
Array of objects
转发规则所属的一个或多个标签。

示例

请求示例

POST https://open.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": "xxxxxxx",
        "RegionName": "xxxxxxx",
        "AccountID": "210xxxx597"
      }
    ],
    "Enable": true,
    "LastOperator": "210xxxx597",
    "ProjectName": "default",
    "Tags": []
  }
}

错误码

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