更新时间:2023-12-07 GMT+08:00

创建终端节点

功能介绍

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

调用方法

请参见如何调用API

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的值)。

Content-Type

String

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

缺省值:application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

subnet_id

String

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

  • VPC的子网网段不能与198.19.128.0/17重叠

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

最小长度:1

最大长度:64

endpoint_service_id

String

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

最小长度:1

最大长度:64

vpc_id

String

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

最小长度:1

最大长度:64

enable_dns

Boolean

是否创建域名。

  • true:创建域名

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

缺省值:false

tags

Array of TagList objects

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

routetables

Array of strings

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

最小长度:0

最大长度:64

数组长度:1 - 10

port_ip

String

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

最小长度:1

最大长度:128

whitelist

Array of strings

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

最小长度:0

最大长度:32

数组长度:1 - 1000

enable_whitelist

Boolean

是否开启网络ACL隔离。

description

String

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

最小长度:0

最大长度:512

表4 TagList

参数

是否必选

参数类型

描述

key

String

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

最小长度:1

最大长度:36

value

String

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

最小长度:1

最大长度:43

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

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

最小长度:1

最大长度:64

service_type

String

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

status

String

终端节点的状态。

  • pendingAcceptance:待接受

  • creating:创建中

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

  • deleting:删除中

ip

String

终端节点ip

最小长度:1

最大长度:64

active_status

Array of strings

帐号状态。

  • frozen:冻结

  • active:解冻

endpoint_service_name

String

终端节点服务的名称。

marker_id

Integer

终端节点的报文标识。

endpoint_service_id

String

终端节点服务的ID。

最小长度:1

最大长度:64

enable_dns

Boolean

是否创建域名。

  • true:创建域名

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

dns_names

Array of strings

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

最小长度:0

最大长度:32

subnet_id

String

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

最小长度:1

最大长度:64

vpc_id

String

终端节点所在的VPC的ID。

最小长度:1

最大长度:64

created_at

String

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

updated_at

String

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

project_id

String

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

最小长度:1

最大长度:64

tags

Array of TagList objects

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

whitelist

Array of strings

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

最小长度:0

最大长度:32

数组长度:1 - 1000

enable_whitelist

Boolean

是否开启网络ACL隔离。

  • true:开启网络ACL隔离

  • false:不开启网络ACL隔离 若未指定,则返回false。 创建连接Interface类型终端节点服务的终端节点时,显示此参数。

routetables

Array of strings

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

最小长度:0

最大长度:64

specification_name

String

规格名称

description

String

描述

最小长度:0

最大长度:128

policy_statement

Array of strings

只涉及开启双端固定的网关型终端节点,响应体展示此字段

最小长度:0

最大长度:128

数组长度:0 - 10

enable_status

String

终端节点是否可用。

  • enable:启用

  • disable:不启用

endpoint_pool_id

String

待废弃,实例相关联的集群ID

最小长度:1

最大长度:64

public_border_group

String

终端节点对应Pool的Public Border Group信息

表6 TagList

参数

参数类型

描述

key

String

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

最小长度:1

最大长度:36

value

String

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

最小长度:1

最大长度:43

请求示例

创建一个终端节点,不创建域名。

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

{
  "subnet_id" : "5d1c1d71-2613-4274-b34e-d82af550f967",
  "vpc_id" : "4e65f8b1-306d-4522-8ecd-aa374000e2a4",
  "endpoint_service_id" : "813d9300-8473-405b-bfcd-f711117bad65",
  "enable_dns" : "false"
}

响应示例

状态码: 200

服务器已成功处理了请求

{
  "id" : "492c776f-2cb9-40a2-9735-d7279ab2bbb6",
  "status" : "accepted",
  "ip" : "172.16.0.154",
  "tags" : [ ],
  "whitelist" : [ ],
  "marker_id" : 302010104,
  "active_status" : [ "active" ],
  "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59",
  "service_type" : "interface",
  "project_id" : "0605767a3300d5762fb7c0186d9e1779",
  "subnet_id" : "fb1b8b7e-f34c-4ff1-b3a7-221acef3b3aa",
  "enable_dns" : false,
  "created_at" : "2022-04-28T02:44:50Z",
  "updated_at" : "2022-04-28T02:56:15Z",
  "endpoint_service_id" : "8843fac2-bc01-445a-a822-c8124ff3968c",
  "endpoint_service_name" : "br-abc-aaa1.vm_test.8843fac2-bc01-445a-a822-c8124ff3968c",
  "enable_whitelist" : false,
  "specification_name" : "default",
  "endpoint_pool_id" : "501f4a3b-6f96-4309-97d1-e291b8ca5b96",
  "enable_status" : "enable",
  "public_border_group" : "center"
}

SDK代码示例

SDK代码示例如下。

创建一个终端节点,不创建域名。

 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
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.*;


public class CreateEndpointSolution {

    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("cn-north-4"))
                .build();
        CreateEndpointRequest request = new CreateEndpointRequest();
        CreateEndpointRequestBody body = new CreateEndpointRequestBody();
        body.withEnableDns(false);
        body.withVpcId("4e65f8b1-306d-4522-8ecd-aa374000e2a4");
        body.withEndpointServiceId("813d9300-8473-405b-bfcd-f711117bad65");
        body.withSubnetId("5d1c1d71-2613-4274-b34e-d82af550f967");
        request.withBody(body);
        try {
            CreateEndpointResponse response = client.createEndpoint(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());
        }
    }
}

创建一个终端节点,不创建域名。

 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
# 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 = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = CreateEndpointRequest()
        request.body = CreateEndpointRequestBody(
            enable_dns=False,
            vpc_id="4e65f8b1-306d-4522-8ecd-aa374000e2a4",
            endpoint_service_id="813d9300-8473-405b-bfcd-f711117bad65",
            subnet_id="5d1c1d71-2613-4274-b34e-d82af550f967"
        )
        response = client.create_endpoint(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个终端节点,不创建域名。

 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
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("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.CreateEndpointRequest{}
	enableDnsCreateEndpointRequestBody:= false
	subnetIdCreateEndpointRequestBody:= "5d1c1d71-2613-4274-b34e-d82af550f967"
	request.Body = &model.CreateEndpointRequestBody{
		EnableDns: &enableDnsCreateEndpointRequestBody,
		VpcId: "4e65f8b1-306d-4522-8ecd-aa374000e2a4",
		EndpointServiceId: "813d9300-8473-405b-bfcd-f711117bad65",
		SubnetId: &subnetIdCreateEndpointRequestBody,
	}
	response, err := client.CreateEndpoint(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码