文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 终端节点/ 开启终端节点服务 - StartVpcep
更新时间:2026-06-18 GMT+08:00
分享

开启终端节点服务 - StartVpcep

功能介绍

终端节点服务(VPC Endpoint Service)通过专属网关,实现跨 VPC 内网访问,可将 VPC 中的服务安全、可靠地提供给其他 VPC 资源使用,无需暴露服务端网络信息,该接口用于开启集群的终端节点服务。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    css:VPCEndpoint:enableOrDisable

    Write

    cluster *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    • vpcep:endpoints:create
    • vpcep:endpoints:list
    • vpcep:endpoints:get
    • vpcep:endpoints:delete
    • vpcep:endpoints:update

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/open

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID,长度为32个字符,由小写字母和数字组成。

默认取值

不涉及

cluster_id

String

参数解释

指定开启终端节点的集群ID。获取方法请参见获取集群ID

约束限制

UUID格式,36个字符。

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

endpoint_with_dns_name

Boolean

参数解释

是否开启内网域名。

约束限制

不涉及

取值范围

  • true:开启。

  • false:不开启。

默认取值

false

profession_vpcep

Boolean

参数解释

是否创建专业型终端节点。

约束限制

不涉及

取值范围

  • true:开启。

  • false:不开启。

默认取值

false

dualstack_enable

Boolean

参数解释

是否开启IPv4/IPv6双栈网络。

约束限制

仅支持在创建专业型终端节点时开启双栈网络,且集群的VPC子网支持IPv6。

取值范围

  • true:开启。

  • false:不开启。

默认取值

false

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

action

String

参数解释

开启终端节点操作行为。

取值范围

createVpcepservice,表示已开启终端节点。

请求示例

开启终端节点服务。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/open

{
  "endpoint_with_dns_name" : true
}

响应示例

状态码:200

请求成功。

{
  "action" : "createVpcepservice"
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码

相关文档