创建终端节点服务
功能介绍
创建终端节点服务,允许其他用户创建终端节点连接您创建的终端节点服务, 使用您所提供的服务。
该接口为异步接口,调用成功会返回200状态码,说明请求已正常下发。 通常创建终端节点服务需要1~2分钟,可以通过查询终端节点服务详情查看创建结果。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/vpc-endpoint-services
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID。 最小长度:1 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。用户Token也就是调用获取用户Token接口的响应值, 该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json, 如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
port_id |
是 |
String |
标识终端节点服务后端资源的ID, 格式为通用唯一识别码(Universally Unique Identifier,下文简称UUID)。 取值为:
最小长度:1 最大长度:64 |
service_name |
否 |
String |
终端节点服务的名称,长度不大于16,允许传入大小写字母、数字、下划线、中划线。
最小长度:0 最大长度:16 |
vpc_id |
是 |
String |
终端节点服务对应后端资源所在的VPC的ID。 最小长度:1 最大长度:64 |
approval_enabled |
否 |
Boolean |
是否需要审批。
缺省值:true |
service_type |
否 |
String |
终端节点服务类型。 仅支持将用户私有服务创建为interface类型的终端节点服务。 终端节点服务类型包括“网关(gateway)型”和“接口(interface)型”:
缺省值:interface |
server_type |
是 |
String |
资源类型。
|
ip |
否 |
String |
接口型VLAN场景服务端IPv4地址或域名 |
ports |
是 |
Array of PortList objects |
服务开放的端口映射列表,详细内容请参见表4-10。 同一个终端节点服务下,不允许重复的端口映射。若多个终端节点服务共用一个port_id, 则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复, 单次最多添加200个。 |
tcp_proxy |
否 |
String |
用于控制将哪些信息(如客户端的源IP、源端口、marker_id等)携带到服务端。 支持携带的客户端信息包括如下两种类型:
缺省值:close |
tags |
否 |
Array of TagList objects |
资源标签列表。同一个终端节点服务最多可添加20个标签。 |
description |
否 |
String |
描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 最小长度:0 最大长度:512 |
ip_version |
否 |
String |
指定终端节点服务的IP版本,仅专业型终端节点服务支持此参数 ● ipv4, IPv4 ● ipv6, IPv6 |
snat_network_id |
否 |
String |
接口型snat的地址段,ip_version为ipv6时必选。创建服务时使用的VPC内的任意一个网络ID。当服务类型为VIP、VM、ELBV2类型时使用 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
client_port |
否 |
Integer |
终端节点访问的端口。 终端节点提供给用户,作为访问终端节点服务的端口,范围1-65535。 最小值:1 最大值:65535 最小长度:1 最大长度:65535 |
server_port |
否 |
Integer |
终端节点服务的端口。 终端节点服务绑定了后端资源,作为提供服务的端口,范围1-65535。 最小值:1 最大值:65535 最小长度:1 最大长度:65535 |
protocol |
否 |
String |
端口映射协议,支持TCP。 缺省值:TCP |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
键。 key不能为空,长度1~128个字符(中文也可以输入128个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。 _sys_开头属于系统标签,租户不能输入。 key两头不能有空格字符。 最小长度:1 最大长度:128 |
value |
否 |
String |
值。 长度0~255个字符(中文也可以输入255个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @。 资源标签值可以为空字符串。 最大长度:255 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
终端节点服务的ID,唯一标识。 最小长度:1 最大长度:64 |
port_id |
String |
标识终端节点服务后端资源的ID, 格式为通用唯一识别码(Universally Unique Identifier,下文简称UUID)。 取值为:
最小长度:1 最大长度:64 |
service_name |
String |
终端节点服务的名称。 最小长度:0 最大长度:128 |
server_type |
String |
资源类型。
|
vpc_id |
String |
终端节点服务对应后端资源所在的VPC的ID。 最小长度:1 最大长度:64 |
pool_id |
String |
终端节点服务对应的集群id |
approval_enabled |
Boolean |
是否需要审批。
|
status |
String |
终端节点服务的状态。
|
service_type |
String |
终端节点服务类型。 终端节点服务类型包括“网关(gateway)型”和“接口(interface)型”:
最小长度:1 最大长度:16 |
created_at |
String |
终端节点服务的创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
updated_at |
String |
终端节点服务的更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ |
project_id |
String |
项目ID 最小长度:1 最大长度:64 |
ip |
String |
接口型VLAN场景服务端IPv4地址或域名 |
ports |
Array of PortList objects |
服务开放的端口映射列表 同一个终端节点服务下,不允许重复的端口映射。 若多个终端节点服务共用一个port_id, 则终端节点服务之间的所有端口映射的server_port和protocol的组合不能重复。 |
tcp_proxy |
String |
用于控制将哪些信息(如客户端的源IP、源端口、marker_id等)携带到服务端。 支持携带的客户端信息包括如下两种类型:
|
tags |
Array of TagList objects |
资源标签列表 |
description |
String |
描述字段,支持中英文字母、数字等字符,不支持“<”或“>”字符。 最小长度:0 最大长度:512 |
enable_policy |
Boolean |
是否允许自定义终端节点策略。
|
ip_version |
String |
指定终端节点服务的IP版本,仅专业型终端节点服务支持此参数 ● ipv4, IPv4 ● ipv6, IPv6 |
参数 |
参数类型 |
描述 |
---|---|---|
client_port |
Integer |
终端节点访问的端口。 终端节点提供给用户,作为访问终端节点服务的端口,范围1-65535。 最小值:1 最大值:65535 最小长度:1 最大长度:65535 |
server_port |
Integer |
终端节点服务的端口。 终端节点服务绑定了后端资源,作为提供服务的端口,范围1-65535。 最小值:1 最大值:65535 最小长度:1 最大长度:65535 |
protocol |
String |
端口映射协议,支持TCP。 缺省值:TCP |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
键。 key不能为空,长度1~128个字符(中文也可以输入128个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。 _sys_开头属于系统标签,租户不能输入。 key两头不能有空格字符。 最小长度:1 最大长度:128 |
value |
String |
值。 长度0~255个字符(中文也可以输入255个字符)。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @。 资源标签值可以为空字符串。 最大长度:255 |
请求示例
创建接口型终端节点服务,资源类型为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 50 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["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 |
服务器已成功处理了请求 |
错误码
请参见错误码。