创建终端节点

功能介绍

创建终端节点，以便访问终端节点服务。

该接口为异步接口，调用成功会返回200状态码，说明请求已正常下发。通常创建终端节点需要1~2分钟，可以通过查询终端节点服务详情查看创建结果。

URI

POST /v1/{project_id}/vpc-endpoints

请求消息

• 参数说明

  表2 请求参数

  名称	是否必选	参数类型	描述
  subnet_id	否 说明： 创建Interface类型Client必选。	String	需要指定vpc_id对应VPC下已创建的网络（network）的ID，UUID格式。 详细内容请参考《虚拟私有云接口参考》中的“查询子网”，详见响应消息中的“id”字段。 说明： 创建连接Interface类型终端节点服务的终端节点时，此参数必选。 VPC的子网网段不能与198.19.128.0/17重叠。 VPC路由表中自定义路由的目的地址不能与198.19.128.0/17重叠。
  endpoint_service_id	是	String	终端节点服务的ID。 可以通过查询终端节点服务概要获取要连接的终端节点服务ID。
  vpc_id	是	String	终端节点所在的VPC的ID。 详细内容请参考《虚拟私有云接口参考》中的“查询VPC”，详见响应消息中的“id”字段。
  enable_dns	否	Boolean	是否创建域名。 true：创建域名 false：不创建域名 默认值为false。 说明： 当创建连接gateway类型终端节点服务的终端节点时，“enable_dns”设置为true或者false，均不创建域名。
  tags	否	Array of objects	标签列表，详细内容请参见表3。 同一个终端节点最多可添加10个标签。
  routetables	否	Array of strings	路由表ID列表。 若未指定，返回默认VPC下路由表ID。 说明： 创建连接Gateway类型终端节点服务的终端节点时，显示此参数。
  port_ip	否 说明： 创建连接Interface类型终端节点服务的终端节点时，此参数必选。	String	访问所连接的终端节点服务的IP。 创建终端节点时，可以指定访问所连接的终端节点服务的IP，目前只支持IPv4类型 。
  whitelist	否	Array of strings	添加用于控制访问终端节点的白名单。 创建终端节点时，支持访问控制，使用此参数可以添加IPv4或CIDR，默认空列表。 说明： 仅当创建连接Interface类型终端节点服务的终端节点时，支持设置此参数。
  enable_whitelist	否	Boolean	是否开启网络ACL隔离。 true：开启网络ACL隔离 false：不开启网络ACL隔离 默认值为false。 说明： 创建连接Interface类型终端节点服务的终端节点时，显示此参数。

  表3 Tags要素说明

  名称	是否必选	参数类型	描述
  key	否	String	键。最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。
  value	否	String	值。每个值最大长度43个unicode字符，可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。

• 请求样例

  POST https://{endpoint}/v1/{project_id}/vpc-endpoints

  { 
  "subnet_id": "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
  "vpc_id": "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
  "tags":[
              {
                  "key":"test1",
                  "value":"test1"
              }
         ],
  "endpoint_service_id":"e0c748b7-d982-47df-ba06-b9c8c7650c1a",
  "enable_dns":true
  }

响应消息

• 参数说明

  表4 响应参数

  参数	参数类型	描述
  id	String	终端节点的ID，唯一标识。
  service_type	String	终端节点连接的终端节点服务类型。 gateway：由运维人员配置。用户无需创建，可直接使用。 interface：包括运维人员配置的云服务和用户自己创建的私有服务。其中，运维人员配置的云服务无需创建，用户可直接使用。 您可以通过查询公共终端节点服务列表查看由运维人员配置的所有用户可见且可连接的终端节点服务，并通过创建终端节点服务创建Interface类型的终端节点服务。
  status	String	终端节点的连接状态。 pendingAcceptance：待接受 creating：创建中 accepted：已接受 rejected：已拒绝 failed：失败
  active_status	String	账号状态。 arrear_frozen：欠费冻结 verify_frozen：未实名认证冻结 police_frozen：公安冻结 illegal_frozen：违规冻结 partner_frozen：合作伙伴冻结 active：解冻
  endpoint_service_name	String	终端节点服务的名称。
  marker_id	Integer	终端节点的报文标识。
  endpoint_service_id	String	终端节点服务的ID。
  enable_dns	Boolean	是否创建域名。 true：创建域名 false：不创建域名 说明： 当创建连接gateway类型终端节点服务的终端节点时，“enable_dns”设置为true或者false，均不创建域名。
  dns_names	Array of strings	访问所连接的终端节点服务的域名。 说明： 当创建连接Interface类型终端节点服务的终端节点，且“enable_dns”设置为true时，显示该参数。 由于创建终端节点接口为异步接口，调用成功会返回200状态码，说明请求已正常下发。通常创建终端节点需要1~2分钟，可以通过查询终端节点服务详情查看创建结果。
  subnet_id	String	vpc_id对应VPC下已创建的网络（network）的ID，UUID格式。 说明： 仅当创建连接interface类型终端节点服务的终端节点时返回该参数。
  vpc_id	String	终端节点所在的VPC的ID。
  created_at	String	终端节点的创建时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  updated_at	String	终端节点的更新时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  project_id	String	项目ID，获取方法请参见获取项目ID。
  tags	Array of objects	资源标签列表，详细内容请参见表5。
  whitelist	Array of strings	控制访问终端节点的白名单。 若未创建，则返回空列表。 说明： 创建连接Interface类型终端节点服务的终端节点时，显示此参数。
  enable_whitelist	Boolean	是否开启网络ACL隔离。 true：开启网络ACL隔离 false：不开启网络ACL隔离 若未指定，则返回false。 说明： 创建连接Interface类型终端节点服务的终端节点时，显示此参数。
  routetables	Array of strings	路由表ID列表。 若未指定，返回默认VPC下路由表ID。 说明： 创建连接Gateway类型终端节点服务的终端节点时，显示此参数。
  enable_status	String	是否启用终端节点。 enable：启用。 disable：禁用。

  表5 Tags要素说明

  名称	参数类型	说明
  key	String	键。最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。
  value	String	值。每个值最大长度43个unicode字符，可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。

状态码

状态码请参见状态码。