文档首页> > API参考> API说明> 终端节点服务功能> 创建终端节点服务

创建终端节点服务

分享
更新时间: 2019/07/11 08:58

功能介绍

创建终端节点服务,允许其他用户创建终端节点连接您创建的终端节点服务,使用您所提供的服务。

说明:

该接口为异步接口,创建终端节点服务需要1~2分钟,接口调用成功会返回200状态码。

URI

  • URI格式

    POST /v1/{project_id}/vpc-endpoint-services

  • 参数说明
    表1 参数说明

    参数

    是否必选

    描述

    project_id

    用户ID。

请求

  • 参数说明
    表2 请求参数

    名称

    是否必选

    参数类型

    描述

    port_id

    String

    终端节点服务的port_id,格式为通用唯一识别码(Universally Unique Identifier,下文简称UUID)。

    取值为:

    • LB类型:参考《弹性负载均衡接口参考》中“负载均衡器(增强型)”的“查询负载均衡详情”章节获取。
    • VM类型:弹性云服务器IP地址对应的网卡ID。
    • VIP类型:虚拟资源所在物理服务器对应的网卡ID。
      说明:
      • 创建终端节点服务时,VPC的子网网段不能与198.19.128.0/20重叠。
      • VPC路由表中自定义路由的目的地址不能与198.19.128.0/20重叠

    vip_port_id

    String

    虚拟IP的网卡ID。

    service_name

    String

    终端节点服务的名称,长度不大于16,允许传入大小写字母、数字、下划线、中划线。

    • 传入为空,存入值为regionName+.+serviceId
    • 传入不为空并校验通过,存入值为regionName+.+serviceName+.+serviceId

    vpc_id

    String

    终端节点服务对应后端资源所在的VPC的ID。

    approval_enabled

    Boolean

    是否需要审批。

    • false:不需要审批,创建的终端节点连接直接为accepted状态。
    • true:需要审批,创建的终端节点连接为pendingAcceptance状态,需要终端节点服务所属用户审核后方可使用。

    默认为true,需要审批。

    service_type

    String

    服务类型,默认为interface。

    server_type

    String

    资源类型。

    • VM:云服务器。
    • VIP:虚拟IP。
    • LB:增强型负载均衡。

    ports

    List

    服务开放的端口映射列表,详细内容请参见表3

    同一个终端节点服务下,不允许重复的端口映射。若多个终端节点服务公用一个port_id,则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复,单次最多添加200个。

    tags

    List<ResourceTag>

    资源标签列表,详细内容请参见表4

    同一个终端节点服务最多可添加50个标签。

    表3 Port要素说明

    属性

    参数类型

    描述

    client_port

    int

    终端节点访问的端口。

    终端节点提供给用户,作为访问终端节点服务的端,范围0-65535。。

    server_port

    int

    终端节点服务的端口。

    终端节点服务绑定了后端资源,作为提供服务的端,范围0-65535。

    protocol

    String

    TCP/UDP,默认TCP。

    表4 ResourceTags要素说明

    名称

    参数类型

    说明

    key

    String

    键。

    最大长度36个字符。 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

    value

    String

    值。

    每个值最大长度43个字符,可以为空字符串。 字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

  • 请求示例
    {
       "port_id": "4189d3c2-8882-4871-a3c2-d380272eed88",
       "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed80",
       "approval_enabled":false,
       "service_type":"interface",
       "server_type":"VM",
       "ports":
      [
        {
          "client_port":"8080",
          "server_port":"80",
          "protocol":"TCP"
        },
        {
          "client_port":"8081",
          "server_port":"80",
          "protocol":"TCP"
        }
      ]
    }

响应消息

  • 参数说明
    表5 响应参数

    参数

    参数类型

    描述

    ID

    String

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

    port_id

    String

    终端节点服务的port_id,格式为通用唯一识别码(Universally Unique Identifier,下文简称UUID)。取值为:

    • LB类型:参考《弹性负载均衡接口参考》中“负载均衡器(增强型)”的“查询负载均衡详情”章节获取。
    • VM类型:弹性云服务器IP地址对应的网卡ID。
    • VIP类型:虚拟资源所在物理服务器对应的网卡ID。

    vip_port_id

    String

    虚拟IP的网卡ID。

    service_name

    String

    终端节点服务的名称。

    service_type

    String

    服务类型,默认为interface。

    server_type

    String

    资源类型。

    • VM:云服务器。
    • VIP:虚拟IP。
    • LB:增强负载均衡型。

    vpc_id

    String

    终端节点服务对应后端资源所在的VPC的ID。

    approval_enabled

    Boolean

    是否需要审批。

    • false:不需要审批,创建的终端节点连接直接为accepted状态。
    • true:需要审批,创建的终端节点连接为pendingAcceptance状态,需要终端节点服务所属用户审核后方可使用。

    默认为true,需要审批。

    status

    String

    终端节点服务的状态。

    • creating:创建中
    • available:可连接
    • failed:失败

    created_at

    String

    终端节点服务的创建时间。

    updated_at

    String

    终端节点服务的更新时间。

    project_id

    String

    项目ID。

    ports

    List

    服务开放的端口映射列表,详细内容请参见表6

    同一个终端节点服务下,不允许重复的端口映射。若多个终端节点服务公用一个port_id,则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复,单次最多添加200个。

    tags

    List

    资源标签列表,详细内容请参见表7

    表6 Port要素说明

    属性

    参数类型

    描述

    client_port

    int

    终端节点访问的端口。

    终端节点提供给用户,作为访问终端节点服务的端,范围0-65535。。

    server_port

    int

    终端节点服务的端口。

    终端节点服务绑定了后端资源,作为提供服务的端,范围0-65535。

    protocol

    String

    TCP/UDP,默认TCP。

    表7 ResourceTags要素说明

    名称

    参数类型

    说明

    key

    String

    键。

    最大长度36个字符。 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

    value

    String

    值。

    每个值最大长度43个字符,可以为空字符串。 字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

  • 响应示例
    {
        "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
        "marker_id":"4478426387921896789412",
        "port_id": "4189d3c2-8882-4871-a3c2-d380272eed88",
        "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed80`",
        "status":"available",
        "approval_enabled":false,
        "service_name": "test123",
        "service_type":"interface",
        "server_type":"VM",
        "project_id": "6e9dfd51d1124e8d8498dce894923a0d",
        "created_at": "2018-01-30T07:42:01.174,
        "ports":
                  [
                    {
                        "client_port":"8080",
                        "server_port":"80",
                        "protocol":"TCP"
                    },
                    {
                        "client_port":"8081",
                        "server_port":"80",
                        "protocol":"TCP"
                    }
                  ]
    }

状态码

状态码请参见状态码

如果您喜欢这篇文档,您还可以:

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区