ListResolverRules-获取转发规则列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListResolverRules-获取转发规则列表

最近更新时间：2024.12.10 10:36:52首次发布时间：2023.06.26 20:59:38

获取转发规则的列表。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListResolverRules`	API 的名称。该参数的取值是 `ListResolverRules`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。
Name	String	否	`rule01`	转发规则的名称。私网解析 PrivateZone 会按照该参数对转发规则的名称进行模糊查询。如果您不传入该参数，则该参数不作为查询条件。
ZoneName	String	否	`example.com`	转发规则所关联的主域名。私网解析 PrivateZone 会按照该参数对主域名进行模糊查询。例如，您把该参数设置为 `example.com`，则对 `example.com` 以及 `example.com` 的所有子域名的 DNS 请求都会被转发。如果您不传入该参数，则该参数不作为查询条件。
EndpointID	Integer	否	`123`	出站终端节点的 ID。如果您不传入该参数，则该参数不作为查询条件。
PageNumber	Integer	否	`1`	页码。页数由获取的转发规则总数和 `PageSize` 确定。默认为 1。
PageSize	Integer	否	`10`	每页包含的转发规则的数量。默认为 10。返回结果会将获取的转发规则进行分页显示。页数由获取的转发规则总数和 `PageSize` 确定。
ProjectName	String	否	`default`	转发规则所属的项目名称。如果您不传入该参数，该参数不作为查询条件。
TagFilters.N	String	否	`TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]}`	转发规则的标签。您需要指定： N：表示 `TagFilters` 的序号，取值范围：1～10。`N` 应按照从小到大的顺序，且必须为连续的数字。标签键：例如 `"Key":"k1"`。如果您指定多个标签键，私网解析 PrivateZone 会查询同时包含所有指定标签键的转发规则。标签值：例如 `Values":["v1", "v2"]`。标签值数组的长度取值范围为 1～3。您可不传入 `Values`，表示查询时 `Values` 不作为查询条件。如果您把仅包含空字符串的数组传入 `Values` ，私网解析 PrivateZone 会查询 `Values` 为空的标签。如果一个 `Values` 包含多个值，这些值之间的关系为逻辑或（OR）。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
Total	Integer	转发规则的总数。
PageNumber	Integer	页码。
PageSize	Integer	每页包含的转发规则的数量。
Rules	Array of Objects	转发规则的详细信息。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230616155126FE7F678484114BA650D8",
    "Action": "ListResolverRules",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-north-1"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 20,
    "Total": 1,
    "Rules": [
      {
        "ID": 86,
        "CreatedAt": "2023-06-16T11:10:43+08:00",
        "UpdatedAt": "2023-06-16T11:13:38+08:00",
        "Name": "testRule",
        "Type": "OUTBOUND",
        "ZoneName": "test.com",
        "EndpointID": 238,
        "ForwardIPs": [
          {
            "IP": "1.1.**.**",
            "Port": 1
          }
        ],
        "Enable": true,
        "LastOperator": "210xxxx597",
        "ProjectName": "default",
        "Tags": []
      }
    ]
  }
}

错误码

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