文档首页> VPC终端节点 VPCEP> API参考> API> 终端节点功能> 更新终端节点
更新时间：2024-06-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新终端节点

功能介绍

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

调用方法

请参见如何调用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

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

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"
  } ]
}

状态码

状态码

描述

200

服务器已成功处理了请求

错误码

请参见错误码。

父主题： 终端节点功能
分享：

    相关文档

    相关产品