QueryResolverEndpoint-获取终端节点详细信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

QueryResolverEndpoint-获取终端节点详细信息

最近更新时间：2024.08.23 14:57:25首次发布时间：2023.06.26 20:59:38

获取一个终端节点的详细信息。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`QueryResolverEndpoint`	API 的名称。该参数的取值是 `QueryResolverEndpoint`。
Version	String	是	`2022-06-01`	表示 API 的版本。该参数的取值是 `2022-06-01`。
EndpointID	Integer	是	`123`	终端节点的 ID。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
ID	Integer	终端节点的 ID。
CreatedAt	String	终端节点的创建时间。
UpdatedAt	String	终端节点的更新时间。
Name	String	终端节点的名称。
Status	String	终端节点的状态。 Creating：创建中。 Running：运行中。 Updating：更新中。 Error：运行异常。
Direction	String	终端节点的 DNS 请求转发方向。 OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。 INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。
VpcID	String	终端节点所在的出站 VPC 的 ID。
VpcRegion	String	终端节点所在的出站 VPC 的地域。
SecurityGroupID	String	适用于终端节点 IP 地址的安全组 ID。
IpConfigs	Array of Objects	终端节点的可用区、子网和 IP 配置。

示例

请求示例

POST https://open.volcengineapi.com/?Action=QueryResolverEndpoint&Version=2022-06-01&EndpointID=234xxx34

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230616153026929D12EE440EEF024075",
    "Action": "QueryResolverEndpoint",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn-north-1"
  },
  "Result": {
    "ID": 238,
    "CreatedAt": "2023-06-16T11:07:21+08:00",
    "UpdatedAt": "2023-06-16T15:15:36+08:00",
    "Name": "xxxx",
    "Status": "Running",
    "Direction": "OUTBOUND",
    "VpcID": "vpc-2bzitkgxxxxxg3ur0cv",
    "VpcRegion": "xxxxxxx",
    "SecurityGroupID": "sg-2bzitkxxxxxf6zlelm",
    "IpConfigs": [
      {
        "AzID": "xxxxxx-a",
        "SubnetID": "subnet-2bzixxxxxxf1mtmn6",
        "IP": "192.168.0.2"
      },
      {
        "AzID": "xxxxxx-b",
        "SubnetID": "subnet-2bzitxxxxxffff81i",
        "IP": "192.168.1.2"
      }
    ]
  }
}

错误码

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