CreateEndpoint-阿里云帮助中心

Creates a private network endpoint for an Elasticsearch Serverless application. You can create up to 50 endpoints in each area. Currently, you can only create a VPC endpoint to connect your VPC network to the Elasticsearch Serverless network. When you invoke this operation, it creates the AliyunServiceRoleForESServerless role by default.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

es-serverless:CreateEndpoint

create

*All Resource

*

None

Request syntax

POST /openapi/es-serverless/endpoints HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The body parameters.
endpointZones	array<object>	Yes	The list of zones.
	object	No
zoneId	string	No	The zone ID. The supported regions and zones are as follows: Hangzhou region: cn-hangzhou-h, cn-hangzhou-g, cn-hangzhou-i Beijing region: cn-beijing-g, cn-beijing-h, cn-beijing-i Shenzhen region: cn-shenzhen-d, cn-shenzhen-e, cn-shenzhen-f Shanghai region: cn-shanghai-b, cn-shanghai-f, cn-shanghai-g	cn-hangzhou-h
vswitchId	string	No	The vSwitch ID.	vsw-uf6qmfkqdcw*****
vpcId	string	Yes	The VPC instance ID.	vpc-uf664nyle5khp5***
name	string	No	The name.	testendpoint
type	string	No	The endpoint type. Default value: VPC.	VPC

Response elements

Element	Type	Description	Example
	object	The request result.
requestId	string	The request ID.	2C5DAA30-****-5181-9B87-9D6181016197
result	object	The result.
endpointId	string	The endpoint ID.	essep-abd***dks

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.