调用CreateVpcEndpoint，创建服务账号VPC下的终端节点，用于连接用户VPC下的终端节点服务，以单向打通网络。

该API的详细信息请参见配置实例私网连接。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/instances/{InstanceId}/vpc-endpoints HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path 是 es-cn-2r429tctl000d****

实例ID。
ClientToken String Query 否 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。
dryRun Boolean Query 否 false

是否只预检此次请求，取值含义如下：

  • true：发送检查请求，不会创建终端节点。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。
  • false（默认值）：立即触发创建终端节点。
Object Body 否

终端节点服务信息。
serviceId String Body 否 epsrv-hp3xdsq46ael67lo****

您创建的终端节点服务ID。服务VPC侧终端节点将要关联的此服务ID。
zoneId String Body 否 cn-hangzhou-i

您创建的终端节点服务对应的可用区ID。

返回数据

名称 类型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC47D9

请求ID。
Result Object

返回结果详情。
serviceId String epsrv-bp1w0p3jdirbfmt6****

终端节点关联的用户终端节点服务的ID。
endpointDomain String ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com

终端节点域名，用于连接配置。
endpointId String ep-bp1tah7zbrwmkjef****

服务VPC侧终端节点ID。
endpointName String vpcElasticSearchABC

服务VPC侧终端节点名称。

示例

请求示例

POST /openapi/instances/es-cn-2r429tctl000d****/vpc-endpoints HTTP/1.1
Content-Type:application/json

{
  "serviceId" : "epsrv-hp3xdsq46ael67lo****",
  "zoneId" : "cn-hangzhou-i"
}

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F99407AB-2FA9-489E-A259-40CF6DCC47D9",
  "Result" : {
    "serviceId" : "epsrv-hp3vpx8yqxblby3i****",
    "endpointName" : "vpcElasticSearchABC",
    "endpointId" : "ep-hp33b2e43fays7s8****",
    "endpointDomain" : "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com"
  }
}

错误码

访问错误中心查看更多错误码。