CreateVpcEndpoint - 创建私网链接VPC终端节点-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:CreateVpcEndpoint

none

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-2r429tctl000d****

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
dryRun	boolean	否	是否只预检此次请求，取值含义如下： true：发送检查请求，不会创建终端节点。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。 false（默认值）：立即触发创建终端节点。	false
body	object	否	终端节点服务信息。
serviceId	string	否	您创建的终端节点服务 ID。服务 VPC 侧终端节点将要关联的此服务 ID。	epsrv-hp3xdsq46ael67lo****
zoneId	string	否	您创建的终端节点服务对应的可用区 ID。	cn-hangzhou-i

返回参数

名称	类型	描述	示例值
	object	返回结果信息。
RequestId	string	请求 ID。	F99407AB-2FA9-489E-A259-40CF6DCC47D9
Result	object	返回结果详情。
serviceId	string	终端节点关联的用户终端节点服务的 ID。	epsrv-bp1w0p3jdirbfmt6****
endpointDomain	string	终端节点域名，用于连接配置。	ep-bp1tah7zbrwmkjef**.epsrv-bp1w0p3jdirbfmt6**.cn-hangzhou.privatelink.aliyuncs.com
endpointId	string	服务 VPC 侧终端节点 ID。	ep-bp1tah7zbrwmkjef****
endpointName	string	服务 VPC 侧终端节点名称。	vpcElasticSearchABC

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。