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

文档中心

立即注册

TrafficRoute DNS 套件

请输入

解析器Resolver

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

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

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	QueryResolverEndpoint	要执行的操作，取值：QueryResolverEndpoint。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
EndpointID	Long	是	123	终端节点的 ID。您可以从以下 API 的响应中获取： CreateResolverEndpoint ListResolverEndpoints
EndpointTrn	String	否	trn:private_zone::21******4::endpoint/ep-1234	终端节点的 TRN。格式为 `trn:private_zone::accountId::endpoint/ep-endpointId`。如果您需要验证子用户是否对终端节点所在的项目有操作权限，您需要传入该参数。

返回参数

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

参数	类型	示例值	描述
ID	Long	238	终端节点的 ID。
CreatedAt	String	2023-06-16T11:07:21+08:00	终端节点的创建时间。
UpdatedAt	String	2023-06-16T11:07:21+08:00	终端节点的更新时间。
Name	String	abcde	终端节点的名称。
Status	String	Creating	终端节点的状态。 Creating：创建中。 Running：运行中。 Updating：更新中。 Error：运行异常。
Direction	String	OUTBOUND	终端节点的 DNS 请求转发方向。 OUTBOUND：出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。 INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。
VpcID	String	vpc-2bzitkgxxxxxg3ur0cv	终端节点所在的出站 VPC 的 ID。
VpcRegion	String	cn-beijing	终端节点所在的出站 VPC 的地域。
SecurityGroupID	String	sg-2bzitkxxxxxf6zlelm	适用于终端节点 IP 地址的安全组 ID。
IpConfigs	Array of Object	无	终端节点的可用区、子网和 IP 配置。
ProjectName	String	default	终端节点所属的项目名称。
Tags	Array of Object	无	终端节点所属的一个或多个标签。

请求示例

POST https://private-zone.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"
      }
    ],
    "ProjectName": "default",
    "Tags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrEndpointNotFound	resolver endpoint not found	未找到转发终端节点
500	ErrInternalServer	server internal error	服务内部错误

最近更新时间：2025.05.22 20:09:36

这个页面对您有帮助吗？

有用

无用