文档

CreateEndpoint - 创建终端节点

更新时间:

调用CreateEndpoint接口,创建ES Serverless应用的私网终端节点。目前仅支持创建VPC类型的端点,用来打通用户VPC网络和ES Serverless服务的网络。调用该接口会默认帮助用户创建AliyunServiceRoleForESServerless角色。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:CreateEndpoint
  • 全部资源
    *

请求语法

POST /openapi/es-serverless/endpoints

请求参数

名称类型必填描述示例值
bodyobject

body 参数

endpointZonesarray<object>

可用区信息列表。

object
zoneIdstring

可用区 ID。目前支持的地域和可用区如下:

  • 杭州区域:cn-hangzhou-h, cn-hangzhou-g, cn-hangzhou-i
  • 北京区域:cn-beijing-g, cn-beijing-h, cn-beijing-i
  • 深圳区域:cn-shenzhen-d, cn-shenzhen-e, cn-shenzhen-f
  • 上海区域:cn-shanghai-b, cn-shanghai-f, cn-shanghai-g
cn-hangzhou-h
vswitchIdstring

虚拟交换机 ID。

vsw-uf6qmfkqdcw*****
vpcIdstring

专有网络实例 ID

vpc-uf664nyle5khp5***
namestring

名称。

testendpoint
typestring

端点类型,默认值 VPC。

VPC

返回参数

名称类型描述示例值
object

请求结果。

requestIdstring

请求 ID。

2C5DAA30-****-5181-9B87-9D6181016197
resultobject

返回结果。

endpointIdstring

端点 ID。

essep-abd***dks

示例

正常返回示例

JSON格式

{
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "result": {
    "endpointId": "essep-abd***dks"
  }
}

错误码

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