CreateResolverEndpoint-添加终端节点--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreateResolverEndpoint-添加终端节点

最近更新时间：2024.11.20 11:13:11首次发布时间：2023.06.26 20:59:38

添加一个终端节点。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CreateResolverEndpoint`	API 的名称。该参数的取值是 `CreateResolverEndpoint`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

名称	类型	是否必选	示例值	描述
Name	String	是	`node01`	终端节点的名称。支持 UTF-8 格式。
Direction	String	否	`OUTBOUND`	终端节点的 DNS 请求转发方向。 OUTBOUND：（默认）出站终端节点，把来自 VPC 内的 DNS 查询请求转发到外部的 DNS 服务器。 INBOUND：入站终端节点，把来自外部的 DNS 查询请求转发到解析器。
VpcID	String	是	`vpc-h15hzxxxxxx3utjvu`	终端节点所在的 VPC 的 ID。
VpcRegion	String	是	`cn-beijing`	终端节点所在的 VPC 的地域。
SecurityGroupID	String	是	`sg-h15i0xxxxxxdhyk2s20`	适用于终端节点 IP 地址的安全组 ID。
IpConfigs	Array of Objects	是		终端节点的可用区、子网和 IP 配置。
ProjectName	String	否	`default`	终端节点所属的项目名称。默认为 `default`。
VpcTrns	Array of strings	否	`["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]`	域名所关联的一个或多个 VPC 的 TRN。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
Tags	Array of objects	否	`[{"Key":"key1", "Value":"value1"},{"Key":"key2", "Value":"value2"}]`	终端节点所属的一个或多个标签。一个资源最多能关联 50 个标签。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
EndpointID	Integer	终端节点的 ID。

示例

请求示例

POST https://open.volcengineapi.com/?Action=CreateResolverEndpoint&Version=2022-06-01

{
    "Name": "testEndPoint",
    "VpcID": "vpc-h15hzxxxxxx3utjvu",
    "VpcRegion": "xxxx",
    "SecurityGroupID": "sg-h15i0xxxxxxdhyk2s20",
    "IpConfigs": [
        {
            "AzID": "cn-beijing-a",
            "SubnetID": "subnet-pedexxxxxxx6puq6gc",
            "IP": "172.16.0.2"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230614140553EC822FFD341E9C19EF59",
        "Action": "CreateResolverEndpoint",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },

    "Result": {
        "EndpointID": 238
    }
     
}

错误码

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