更新时间:2024-03-15 GMT+08:00
分享

创建终端节点服务

功能介绍

创建终端节点服务,允许其他用户创建终端节点连接您创建的终端节点服务, 使用您所提供的服务。 说明 该接口为异步接口,调用成功会返回200状态码,说明请求已正常下发。 通常创建终端节点服务需要1~2分钟,可以通过查询终端节点服务详情查看创建结果。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见获取项目ID。

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。用户Token也就是调用获取用户Token接口的响应值, 该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。

Content-Type

String

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

缺省值:application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

port_id

String

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

  • LB类型:负载均衡器内网IP对应的端口ID。 详细内容请参考《弹性负载均衡API参考》中的“查询负载均衡详情”。

  • VM类型:弹性云服务器IP地址对应的网卡ID。 详细内容请参考《弹性云服务器API参考》中的“查询云服务器网卡信息”, 详见响应消息中的“port_id”字段。

  • VIP类型:虚拟IP所在虚拟机的网卡ID(VIP类型业务已不支持,该取值类型已废弃) 说明:

  • 创建终端节点服务时,VPC的子网网段不能与198.19.128.0/17重叠。

  • VPC路由表中自定义路由的目的地址不能与198.19.128.0/17重叠。

最小长度:1

最大长度:64

service_name

String

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

  • 传入为空,存入值为regionName+.+serviceId

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

最小长度:0

最大长度:16

vpc_id

String

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

最小长度:1

最大长度:64

approval_enabled

Boolean

是否需要审批。

  • false:不需要审批,创建的终端节点连接直接为accepted状态。

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

缺省值:true

service_type

String

终端节点服务类型。 仅支持将用户私有服务创建为interface类型的终端节点服务。 终端节点服务类型包括“网关(gateway)型”和“接口(interface)型”:

  • gateway:由运维人员配置。用户无需创建,可直接使用。

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

缺省值:interface

server_type

String

资源类型。

  • VM:云服务器,适用于作为服务器使用。

  • VIP:虚拟IP,适用于作为虚IP场景使用。(该字段已废弃,请优先使用LB类型)

  • LB:负载均衡,适用于高访问量业务和对可靠性和容灾性要求较高的业务。

ports

Array of PortList objects

服务开放的端口映射列表,详细内容请参见表4-10。 同一个终端节点服务下,不允许重复的端口映射。若多个终端节点服务共用一个port_id, 则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复, 单次最多添加200个。

tcp_proxy

String

用于控制将哪些信息(如客户端的源IP、源端口、marker_id等)携带到服务端。 支持携带的客户端信息包括如下两种类型:

  • TCP TOA:表示将客户端信息插入到tcp option字段中携带至服务端。 说明:仅当后端资源为OBS时,支持TCP TOA类型信息携带方式。

  • Proxy Protocol:表示将客户端信息插入到tcp payload字段中携带至服务端。 仅当服务端支持解析上述字段时,该参数设置才有效。 该参数的取值包括:

  • close:表示关闭代理协议。

  • toa_open:表示开启代理协议“tcp_toa”。

  • proxy_open:表示开启代理协议“proxy_protocol”。

  • open:表示同时开启代理协议“tcp_toa”和“proxy_protocol”。

  • proxy_vni: 关闭toa,开启proxy和vni。 默认值为“close”。

缺省值:close

tags

Array of TagList objects

资源标签列表。同一个终端节点服务最多可添加10个标签。

description

String

描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。

最小长度:0

最大长度:512

enable_policy

Boolean

是否开启终端节点策略。

  • false:不支持设置终端节点策略

  • true:支持设置终端节点策略 默认为false

缺省值:false

表4 PortList

参数

是否必选

参数类型

描述

client_port

Integer

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

最小值:1

最大值:65535

最小长度:1

最大长度:65535

server_port

Integer

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

最小值:1

最大值:65535

最小长度:1

最大长度:65535

protocol

String

端口映射协议,支持TCP。

缺省值:TCP

表5 TagList

参数

是否必选

参数类型

描述

key

String

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

最小长度:1

最大长度:36

value

String

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

最小长度:1

最大长度:43

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

id

String

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

最小长度:1

最大长度:64

port_id

String

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

  • LB类型:负载均衡器内网IP对应的端口ID。

  • VM类型:弹性云服务器IP地址对应的网卡ID。

  • VIP类型:虚拟资源所在物理服务器对应的网卡ID。(该字段已废弃,请优先使用LB类型)

最小长度:1

最大长度:64

service_name

String

终端节点服务的名称。

最小长度:0

最大长度:128

server_type

String

资源类型。

  • VM:云服务器。

  • VIP:虚拟IP。

  • LB:增强负载均衡型。

vpc_id

String

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

最小长度:1

最大长度:64

pool_id

String

终端节点服务对应的集群id

approval_enabled

Boolean

是否需要审批。

  • false:不需要审批,创建的终端节点连接直接为accepted状态。

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

status

String

终端节点服务的状态。

  • creating:创建中

  • available:可连接

  • failed:失败

service_type

String

终端节点服务类型。 终端节点服务类型包括“网关(gateway)型”和“接口(interface)型”:

  • gateway:由运维人员配置。用户无需创建,可直接使用。

  • interface:包括运维人员配置的云服务和用户自己创建的私有服务。 其中,运维人员配置的云服务无需创建,用户可直接使用。 您可以通过创建终端节点创建访问Gateway和Interface类型终端节点服务的终端节点。

最小长度:1

最大长度:16

created_at

String

终端节点服务的创建时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ

updated_at

String

终端节点服务的更新时间。 采用UTC时间格式,格式为:YYYY-MMDDTHH:MM:SSZ

project_id

String

项目ID

最小长度:1

最大长度:64

ports

Array of PortList objects

服务开放的端口映射列表 同一个终端节点服务下,不允许重复的端口映射。 若多个终端节点服务共用一个port_id, 则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复。

tcp_proxy

String

用于控制将哪些信息(如客户端的源IP、源端口、marker_id等)携带到服务端。 支持携带的客户端信息包括如下两种类型:

  • TCP TOA:表示将客户端信息插入到tcp option字段中携带至服务端。 说明:仅当后端资源为OBS时,支持TCP TOA类型信息携带方式。

  • Proxy Protocol:表示将客户端信息插入到tcp payload字段中携带至服务端。 仅当服务端支持解析上述字段时,该参数设置才有效。 该参数的取值包括:

  • close:表示关闭代理协议。

  • toa_open:表示开启代理协议“tcp_toa”。

  • proxy_open:表示开启代理协议“proxy_protocol”。

  • open:表示同时开启代理协议“tcp_toa”和“proxy_protocol”。

  • proxy_vni: 关闭toa,开启proxy和vni。 默认值为“close”。

tags

Array of TagList objects

资源标签列表

description

String

描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。

最小长度:0

最大长度:512

enable_policy

Boolean

是否开启终端节点策略。

  • false:不支持设置终端节点策略

  • true:支持设置终端节点策略 默认为false

表7 PortList

参数

参数类型

描述

client_port

Integer

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

最小值:1

最大值:65535

最小长度:1

最大长度:65535

server_port

Integer

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

最小值:1

最大值:65535

最小长度:1

最大长度:65535

protocol

String

端口映射协议,支持TCP。

缺省值:TCP

表8 TagList

参数

参数类型

描述

key

String

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

最小长度:1

最大长度:36

value

String

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

最小长度:1

最大长度:43

请求示例

创建接口型终端节点服务,资源类型为VM,访问端口为8080和8081,服务端口为90和80,端口映射协议为TCP,无需审批。

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

{
  "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" : 90,
    "protocol" : "TCP"
  }, {
    "client_port" : 8081,
    "server_port" : 80,
    "protocol" : "TCP"
  } ]
}

响应示例

状态码: 200

服务器已成功处理了请求

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
  "pool_id" : "5289d3c2-8882-4871-a3c2-d380272eed80",
  "status" : "available",
  "approval_enabled" : false,
  "service_name" : "test123",
  "service_type" : "interface",
  "server_type" : "VM",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "created_at" : "2022-04-14T09:35:47Z",
  "ports" : [ {
    "client_port" : 8080,
    "server_port" : 90,
    "protocol" : "TCP"
  }, {
    "client_port" : 8081,
    "server_port" : 80,
    "protocol" : "TCP"
  } ]
}

SDK代码示例

SDK代码示例如下。

创建接口型终端节点服务,资源类型为VM,访问端口为8080和8081,服务端口为90和80,端口映射协议为TCP,无需审批。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion;
import com.huaweicloud.sdk.vpcep.v1.*;
import com.huaweicloud.sdk.vpcep.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateEndpointServiceSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        VpcepClient client = VpcepClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcepRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateEndpointServiceRequest request = new CreateEndpointServiceRequest();
        CreateEndpointServiceRequestBody body = new CreateEndpointServiceRequestBody();
        List<PortList> listbodyPorts = new ArrayList<>();
        listbodyPorts.add(
            new PortList()
                .withClientPort(8080)
                .withServerPort(90)
                .withProtocol(PortList.ProtocolEnum.fromValue("TCP"))
        );
        listbodyPorts.add(
            new PortList()
                .withClientPort(8081)
                .withServerPort(80)
                .withProtocol(PortList.ProtocolEnum.fromValue("TCP"))
        );
        body.withPorts(listbodyPorts);
        body.withServerType(CreateEndpointServiceRequestBody.ServerTypeEnum.fromValue("VM"));
        body.withServiceType(CreateEndpointServiceRequestBody.ServiceTypeEnum.fromValue("interface"));
        body.withApprovalEnabled(false);
        body.withVpcId("4189d3c2-8882-4871-a3c2-d380272eed80");
        body.withPortId("4189d3c2-8882-4871-a3c2-d380272eed88");
        request.withBody(body);
        try {
            CreateEndpointServiceResponse response = client.createEndpointService(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建接口型终端节点服务,资源类型为VM,访问端口为8080和8081,服务端口为90和80,端口映射协议为TCP,无需审批。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpcep.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateEndpointServiceRequest()
        listPortsbody = [
            PortList(
                client_port=8080,
                server_port=90,
                protocol="TCP"
            ),
            PortList(
                client_port=8081,
                server_port=80,
                protocol="TCP"
            )
        ]
        request.body = CreateEndpointServiceRequestBody(
            ports=listPortsbody,
            server_type="VM",
            service_type="interface",
            approval_enabled=False,
            vpc_id="4189d3c2-8882-4871-a3c2-d380272eed80",
            port_id="4189d3c2-8882-4871-a3c2-d380272eed88"
        )
        response = client.create_endpoint_service(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建接口型终端节点服务,资源类型为VM,访问端口为8080和8081,服务端口为90和80,端口映射协议为TCP,无需审批。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := vpcep.NewVpcepClient(
        vpcep.VpcepClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateEndpointServiceRequest{}
	clientPortPorts:= int32(8080)
	serverPortPorts:= int32(90)
	protocolPorts:= model.GetPortListProtocolEnum().TCP
	clientPortPorts1:= int32(8081)
	serverPortPorts1:= int32(80)
	protocolPorts1:= model.GetPortListProtocolEnum().TCP
	var listPortsbody = []model.PortList{
        {
            ClientPort: &clientPortPorts,
            ServerPort: &serverPortPorts,
            Protocol: &protocolPorts,
        },
        {
            ClientPort: &clientPortPorts1,
            ServerPort: &serverPortPorts1,
            Protocol: &protocolPorts1,
        },
    }
	serviceTypeCreateEndpointServiceRequestBody:= model.GetCreateEndpointServiceRequestBodyServiceTypeEnum().INTERFACE
	approvalEnabledCreateEndpointServiceRequestBody:= false
	request.Body = &model.CreateEndpointServiceRequestBody{
		Ports: listPortsbody,
		ServerType: model.GetCreateEndpointServiceRequestBodyServerTypeEnum().VM,
		ServiceType: &serviceTypeCreateEndpointServiceRequestBody,
		ApprovalEnabled: &approvalEnabledCreateEndpointServiceRequestBody,
		VpcId: "4189d3c2-8882-4871-a3c2-d380272eed80",
		PortId: "4189d3c2-8882-4871-a3c2-d380272eed88",
	}
	response, err := client.CreateEndpointService(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码

分享:

    相关文档

    相关产品