使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListResolverRules	要执行的操作，取值：ListResolverRules。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
PageSize	Integer	否	10	每页包含的域名数量。系统会将获取的域名进行分页显示。页数是由获取的域名总数和 PageSize 确定。该参数的默认值是 10，最大值是 500。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的域名。该参数的默认值是 1。
TagFilters	Array of Object	否	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）。
ProjectName	String	否	default	转发规则所属的项目名称。如果您不传入该参数，该参数不作为查询条件。
EndpointID	Integer	否	123	出站终端节点的 ID。如果您不传入该参数，则该参数不作为查询条件。您可以从以下 API 的响应中获取： CreateResolverEndpoint ListResolverEndpoints
EndpointTrn	String	否	trn:private_zone::21******4::endpoint/ep-1234	终端节点的 TRN。格式为 `trn:private_zone::accountId::endpoint/ep-endpointId`。如果您需要验证子用户是否对终端节点所在的项目有操作权限，您需要传入该参数。
Name	String	否	rule01	转发规则的名称。私网解析 PrivateZone 会按照该参数对转发规则的名称进行模糊查询。如果您不传入该参数，则该参数不作为查询条件。
ZoneName	String	否	example.com	转发规则所关联的主域名。私网解析 PrivateZone 会按照该参数对主域名进行模糊查询。例如，您把该参数设置为 `example.com`，则对 `example.com` 以及 `example.com` 的所有子域名的 DNS 请求都会被转发。如果您不传入该参数，则该参数不作为查询条件。

返回参数

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

参数	类型	示例值	描述
Total	Integer	10	转发规则的总数。
Rules	Array of Object	无	转发规则的详细信息。
PageNumber	Integer	1	页码。
PageSize	Integer	10	每页包含的转发规则的数量。

请求示例

GET https://private-zone.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": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
500	ErrInternalServer	server internal error	服务内部错误

最近更新时间：2025.05.22 21:08:59

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #