You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

获取终端节点列表

最近更新时间：2023.12.15 10:24:15

首次发布时间：2023.06.26 20:59:38

我的收藏

API 说明

API 名称：ListResolverEndpoints。
API 域名：open.volcengineapi.com。
API 描述：获取终端节点的列表。

请求方法

POST

请求参数

除了以下参数，您还需要在请求头中指定 请求方法 并包含 签名参数。

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 ListResolverEndpoints。
VersionString查询参数是表示 API 的版本。该参数的取值是 2022-06-01。
NameString查询参数否终端节点的名称。
VpcIDString查询参数否终端节点所属的 VPC 的 ID。
StatusString查询参数否终端节点的状态。
  • Creating：创建中。
  • Running：运行中。
  • Updating：更新中。
  • Error：运行异常。
DirectionString查询参数否终端节点的 DNS 请求转发方向。如果您不设置该参数，列表中会同时包含出站终端节点和入站终端节点。
  • OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。
  • INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。
PageNumberInteger查询参数否页码。页数由获取的终端节点总数和 PageSize 确定。
默认为 1。

PageSize

Integer

查询参数

否

每页包含的终端节点的数量。
默认为 10。
返回结果会将获取的终端节点进行分页显示。页数由获取的终端节点总数和 PageSize 确定。

响应正文

参数名称
数据类型
参数说明
ResponseMetadata
Object
响应的元数据。
Result
Object
响应结果。

示例

请求示例

GET https://open.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"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "Total": 1
  }
}