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

更新终端节点

功能介绍

更新或删除允许访问终端节点的白名单。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

vpc_endpoint_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参数

参数

是否必选

参数类型

描述

whitelist

Array of strings

更新或删除用于控制访问终端节点的白名单。此参数可以添加IPv4或CIDR:

  • 当取值不为空时,表示将白名单更新为取值所示内容。

  • 当取值为空时,表示删除所有白名单。 默认为空列表。

最小长度:0

最大长度:32

数组长度:1 - 1000

enable_whitelist

Boolean

是否开启网络ACL隔离。

  • true:开启网络ACL隔离

  • false:不开启网络ACL隔离 默认值为false。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

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

最小长度:1

最大长度:64

service_type

String

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

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

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

status

String

终端节点的连接状态。

  • pendingAcceptance:待接受

  • creating:创建中

  • accepted:已接受

  • rejected:已拒绝

  • failed:失败

  • deleting:删除中

ip

String

访问所连接的终端节点服务的IP。 仅当同时满足如下条件时,返回该参数:

  • 当查询连接interface类型终端节点服务的终端节点时。

  • 终端节点服务启用“连接审批”功能,且已经“接受”连接审批。 “status”可以是“accepted”或者“rejected(仅支持“接受”连接审批后再“拒绝”的情况)”。

最小长度: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类型终端节点服务的终端节点时,显示此参数。

表5 TagList

参数

参数类型

描述

key

String

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

最小长度:1

最大长度:36

value

String

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

最小长度:1

最大长度:43

请求示例

更新终端节点,设置白名单信息为192.168.1.1、192.168.1.2,开启网络ACL隔离。

PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83

{ 
  "whitelist":
             [
              "192.168.1.1",
              "192.168.1.2"
             ],
  "enable_whitelist":true,
}

响应示例

状态码: 200

服务器已成功处理了请求

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "service_type" : "interface",
  "status" : "accepted",
  "ip" : "10.32.xx.xx",
  "marker_id" : 322312312312,
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "enable_dns" : true,
  "endpoint_service_name" : "test123",
  "endpoint_service_id" : "test123",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "whitelist" : [ "192.168.1.1", "192.168.1.2" ],
  "enable_whitelist" : true,
  "created_at" : "2022-04-14T09:35:47Z",
  "updated_at" : "2022-04-14T09:36:47Z",
  "tags" : [ {
    "key" : "test1",
    "value" : "test1"
  } ]
}

SDK代码示例

SDK代码示例如下。

更新终端节点,设置白名单信息为192.168.1.1、192.168.1.2,开启网络ACL隔离。

 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
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 UpdateEndpointWhiteSolution {

    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();
        UpdateEndpointWhiteRequest request = new UpdateEndpointWhiteRequest();
        UpdateEndpointWhiteRequestBody body = new UpdateEndpointWhiteRequestBody();
        List<String> listbodyWhitelist = new ArrayList<>();
        listbodyWhitelist.add("192.168.1.1");
        listbodyWhitelist.add("192.168.1.2");
        body.withEnableWhitelist(true);
        body.withWhitelist(listbodyWhitelist);
        request.withBody(body);
        try {
            UpdateEndpointWhiteResponse response = client.updateEndpointWhite(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());
        }
    }
}

更新终端节点,设置白名单信息为192.168.1.1、192.168.1.2,开启网络ACL隔离。

 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
# 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 = UpdateEndpointWhiteRequest()
        listWhitelistbody = [
            "192.168.1.1",
            "192.168.1.2"
        ]
        request.body = UpdateEndpointWhiteRequestBody(
            enable_whitelist=True,
            whitelist=listWhitelistbody
        )
        response = client.update_endpoint_white(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新终端节点,设置白名单信息为192.168.1.1、192.168.1.2,开启网络ACL隔离。

 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
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.UpdateEndpointWhiteRequest{}
	var listWhitelistbody = []string{
        "192.168.1.1",
	    "192.168.1.2",
    }
	enableWhitelistUpdateEndpointWhiteRequestBody:= true
	request.Body = &model.UpdateEndpointWhiteRequestBody{
		EnableWhitelist: &enableWhitelistUpdateEndpointWhiteRequestBody,
		Whitelist: &listWhitelistbody,
	}
	response, err := client.UpdateEndpointWhite(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码