更新时间:2026-09-15 GMT+08:00

创建终端节点

功能介绍

创建终端节点。

URI

POST /v2.1/endpoints

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

待创建的终端节点名称。

取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

direction

String

终端节点方向。

取值:

inbound,表示入站终端节点。

outbound,表示出站终端节点。

region

String

当前子网所在的region。

ipaddresses

Array of IpaddressInfo objects

终端节点的IP地址和子网信息。最少需要添加2个IP地址,最多可以添加6个IP地址。

表3 IpaddressInfo

参数

是否必选

参数类型

描述

subnet_id

String

子网的ID。

ip

String

自定义IP地址,需在子网的网段内部。

响应参数

状态码:202

表4 响应Body参数

参数

参数类型

描述

endpoint

EndpointResp object

终端节点对象。

表5 EndpointResp

参数

参数类型

描述

id

String

终端节点的ID,UUID形式的一个资源标识。

name

String

终端节点的名称。

direction

String

终端节点方向。

取值:

inbound,表示入站终端节点。

outbound,表示出站终端节点。

status

String

资源状态。

取值范围:PENDING_CREATE, ACTIVE, PENDING_DELETE, ERROR。

vpc_id

String

终端节点所属的VPC ID。

ipaddress_count

Integer

该终端节点下的IP地址数量。

resolver_rule_count

Integer

该终端节点下的转发规则数量。

仅创建出站终端节点时返回该参数。

create_time

String

创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

update_time

String

更新时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

请求示例

创建入站终端节点,设置IP地址1的子网ID为 "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为 "192.168.3.125";设置IP地址2的子网ID为"0463c8a5-fa49-441d-b28b-bc6c35ba04f8",自定义IP为"192.168.3.126"。

POST https://{endpoint}/v2.1/endpoints

{
  "name" : "poi-1",
  "direction" : "inbound",
  "region" : "xx",
  "ipaddresses" : [ {
    "subnet_id" : "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",
    "ip" : "192.168.3.125"
  }, {
    "subnet_id" : "0463c8a5-fa49-441d-b28b-bc6c35ba04f8",
    "ip" : "192.168.3.126"
  } ]
}

响应示例

状态码:202

创建终端节点响应。

{
  "endpoint" : {
    "id" : "ff80808169bf16c70169bf1d02270000",
    "name" : "poi-1",
    "direction" : "inbound",
    "status" : "PENDING_CREATE",
    "vpc_id" : null,
    "ipaddress_count" : 0,
    "resolver_rule_count" : 0,
    "create_time" : "2019-03-27T12:25:43.181",
    "update_time" : "2019-03-27T12:25:43.181"
  }
}

状态码

状态码

描述

202

创建终端节点响应。

错误码

请参见错误码