更新时间:2022-04-27 GMT+08:00
分享

创建终端节点

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/vpc-endpoints

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:2048

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

最小长度:1

最大长度:64

表3 请求Body参数

参数

是否必选

参数类型

描述

subnet_id

String

创建Interface类型Client必选。

需要指定vpc_id对应VPC下已创建的网络(network)的 ID,UUID格式。 详细内容请参考《虚拟私有云 API参考》中的“查询子 网”,详见响应消息中的 “id”段。 创建连接Interface类型终端节点服务的终端节点时,此参数必选。

最小长度:1

最大长度:64

说明:
  • VPC的子网网段不能与 198.19.128.0/17重叠 。
  • VPC路由表中自定义路由的目 的地址不能与 198.19.128.0/17重叠。

endpoint_service_id

String

终端节点服务的ID。 可以通过查询终端节点服务概要获取要连接的终端节点服务 ID。

最小长度:1

最大长度:64

vpc_id

String

终端节点所在的VPC的ID。 详细内容请参考《虚拟私有云API参考》中的“查询VPC”, 详见响应消息中的“id”字段。

最小长度:1

最大长度:64

enable_dns

Boolean

是否创建域名。

  • true:创建域名
  • false:不创建域名
说明:

当创建连接gateway类型终端节点服务的终端节点时,“enable_dns”设置为true或者false,均不创建域名。

缺省值:false

tags

Array of TagList objects

标签列表,没有标签默认为空数组。

routetables

Array of strings

路由表ID列表。详细内容请参考《虚拟私有云API参考》中的“查询VPC路由”,详见响应消息中的“id”字段。 创建连接gateway类型终端节点服务的终节点时,此参数必选。

说明:

不设置此参数时,选择默认路由表。

port_ip

String

访问所连接的终端节点服务的IP。 创建终端节点时,可以指定访问所连接的终端节点服务的IP,目前只支持IPv4类型 。 创建连接Interface类型终端节点服务的终端节点时,此参数必选。

最小长度:1

最大长度:128

whitelist

Array of strings

添加用于控制访问终端节点的白名单。 创建终端节点时,支持访问控制,使用此参数可以添加IPv4或CIDR,默认空列表。 仅当创建连接Interface类型终端节点服务的终端节点时,支持设置此参数。

enable_whitelist

Boolean

是否开启网络ACL隔离。

表4 TagList

参数

是否必选

参数类型

描述

key

String

键。最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、 “<”、“>”、“\”、“,”、“|”和 “/”,且首尾字符不能为空格。

最小长度:1

最大长度:36

value

String

值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含 “=”、“*”、“<”、“>”、“\”、 “,”、“|”和“/”,且首尾字符不能为空格。

最小长度:1

最大长度:43

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

终端节点的ID,唯一标识。

service_type

String

终端节点连接的终端节点服务类型。

  • gataway:由运维人员配置。用户无需创建,可直接使用。
  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。

其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过查询公共终端节点服务列表查看由运维人员配置的所有用户可见且可连接的终端节点服务,并创建Interface类型的终端节点服务。

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受
  • creating:创建中
  • accepted:已接受
  • failed:失败

active_status

Array of strings

帐号状态。

  • 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

访问所连接的终端节点服务的域名。 当“enable_dns”为true时,该参数可见。

subnet_id

String

vpc_id对应VPC下已创建的网络 (network)的ID,UUID格式。

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 TagList objects

标签列表,没有标签默认为空数组。

whitelist

Array of strings

控制访问终端节点的白名单。 若未创建,则返回空列表。 创建连接Interface类型终端节点服务的终端节点时,显示此参 数。

enable_whitelist

Boolean

是否开启网络ACL隔离。

  • true:开启网络ACL隔离
  • false:不开启网络ACL隔离。若未指定,则返回false。

创建连接Interface类型终端节点服务的终端节点时,显示此参数。

routetables

Array of strings

路由表ID列表。 若未指定,返回默认VPC下路由表 ID。 创建连接Gateway类型终端节点服务的终端节点时,显示此参 数。

表6 TagList

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、 “<”、“>”、“\”、“,”、“|”和 “/”,且首尾字符不能为空格。

最小长度:1

最大长度:36

value

String

值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含 “=”、“*”、“<”、“>”、“\”、 “,”、“|”和“/”,且首尾字符不能为空格。

最小长度:1

最大长度:43

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表8 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表10 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表12 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 404

表13 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表14 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 405

表15 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表16 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 406

表17 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表18 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 407

表19 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表20 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 408

表21 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表22 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 409

表23 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表24 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 500

表25 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表26 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 501

表27 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表28 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 502

表29 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表30 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 503

表31 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表32 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

状态码: 504

表33 响应Body参数

参数

参数类型

描述

error

Error object

提交任务异常时返回的异常信息

表34 Error

参数

参数类型

描述

message

String

任务异常错误信息描述

code

String

任务异常错误信息编码

请求示例

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
}

响应示例

状态码: 200

服务器已成功处理了请求

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "service_type" : "interface",
  "marker_id" : 322312312312,
  "status" : "creating",
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "enable_dns" : false,
  "endpoint_service_name" : "test123",
  "endpoint_service_id" : "test123",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "whitelist" : [ "127.0.0.1" ],
  "enable_whitelist" : true,
  "created_at" : "2018-01-30T07:42:01Z",
  "update_at" : "2018-01-30T07:42:01Z",
  "tags" : [ {
    "key" : "test1",
    "value" : "test1"
  } ]
}

状态码

状态码

描述

200

服务器已成功处理了请求

400

服务器未能处理请求

401

被请求的页面需要用户名和密码

403

对被请求页面的访问被禁止

404

服务器无法找到被请求的页面

405

请求中指定的方法不被允许

406

服务器生成的响应无法被客户端所接受

407

用户必须首先使用代理服务器进行验证,这样请求才会被处理

408

请求超出了服务器的等待时间

409

由于冲突,请求无法被完成

500

请求未完成。服务异常

501

请求未完成。服务器不支持所请求的功能

502

请求未完成。服务器从上游服务器收到一个无效的响应

503

请求未完成。系统暂时异常

504

网关超时

错误码

请参见错误码

分享:

    相关文档

    相关产品

close