You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/私网解析 PrivateZone/API 参考/解析器Resolver/ListResolverEndpoints - 获取终端节点列表
ListResolverEndpoints - 获取终端节点列表
最近更新时间：2025.05.22 20:09:55首次发布时间：2023.06.26 20:59:38
我的收藏
有用
有用
无用
无用

获取终端节点的列表。

使用说明

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

请求说明

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

调试

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

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

ListResolverEndpoints

要执行的操作，取值：ListResolverEndpoints。

Version
String
是

2022-06-01

API的版本，取值：2022-06-01。

PageNumber
Integer
否

1

页码。API 返回该页码所包含的域名。该参数的默认值是 1。

PageSize
Integer
否

10

每页包含的域名数量。 系统会将获取的域名进行分页显示。页数是由获取的域名总数和 PageSize 确定。 该参数的默认值是 10，最大值是 500。

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

终端节点所属的项目名称。如果您不传入该参数，该参数不作为查询条件。

VpcTrns
Array of String
否

["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]

域名所关联的一个或多个 VPC 的 TRN。格式为 trn:vpc:region:accountId:vpc/vpcId。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。

Name
String
否

node001

终端节点的名称。如果您不传入该参数，该参数不会作为查询条件。

VpcID
String
否

vpc-2bzitkgxxxxxg3ur0cv

终端节点所属的 VPC 的 ID。如果您不传入该参数，该参数不会作为查询条件。

Status
String
否

Updating

终端节点的状态。

  • Creating：创建中。
  • Running：运行中。
  • Updating：更新中。
  • Error：运行异常。
    如果您不传入该参数，该参数不会作为查询条件。
Direction
String
否

OUTBOUND

终端节点的 DNS 请求转发方向。如果您不设置该参数，列表中会同时包含出站终端节点和入站终端节点。

  • OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。
  • INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。

返回参数

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

参数
类型
示例值
描述
Endpoints
Array of Object

无

终端节点信息

Total
Integer

10

终端节点总数。

PageNumber
Integer

1

页码。

PageSize
Integer

10

每页包含的转发节点的数量。

请求示例

GET https://private-zone.volcengineapi.com/?Action=ListResolverEndpoints&Version=2022-06-01

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230616141900294A2272398E16B6FEB6",
    "Action": "ListResolverEndpoints",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-north-1"
  },
  "Result": {
    "Endpoints": [
      {
        "ID": 238,
        "CreatedAt": "2023-06-16T11:07:21+08:00",
        "UpdatedAt": "2023-06-16T11:07:54+08:00",
        "Name": "xxxx",
        "Status": "Running",
        "Direction": "OUTBOUND",
        "VpcID": "vpc-2bzitxxxxxxxeg3ur0cv",
        "VpcRegion": "xxxxxx",
        "SecurityGroupID": "sg-2bzixxxxxef6zlelm",
        "IpConfigs": [
          {
            "AzID": "xxxxxx-a",
            "SubnetID": "subnet-2bzitxxxxxef1mtmn6",
            "IP": "192.168.0.2"
          },
          {
            "AzID": "xxxxxx-b",
            "SubnetID": "subnet-2bzitxxxxxx2dx0effff81i",
            "IP": "192.168.1.2"
          }
        ],
        "ProjectName": "default",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "Total": 1
  }
}

错误码

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

状态码
错误码
错误信息
说明
500
ErrInternalServer

server internal error

服务内部错误