UpdateApp-阿里云帮助中心

Call the UpdateApp API to update Elasticsearch Serverless application information, such as remarks, network settings, IP address whitelist groups, and account passwords.

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:UpdateApp

update

*All Resource

*

None

Request syntax

PATCH /openapi/es-serverless/instances/{appName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appName	string	Yes	The application name. Call ListApps to get the application name.	test

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
description	string	No	The description of the application.	test
network	array<object>	No	The public network settings.
	array<object>	No	The structure for the public network settings.
type	string	No	The type of the IP address whitelist. Valid values: PUBLIC_ES: the IP address whitelist for public access to Elasticsearch PUBLIC_KIBANA: the IP address whitelist for public access to Kibana	PUBLIC_ES
enabled	boolean	No	Specifies whether to enable public access.	true
domain	string	No	The domain name. This parameter cannot be modified.	test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com
port	integer	No	The port number. This parameter cannot be modified.	9200
whiteIpGroup	array<object>	No	The IP address whitelists.
	object	No	The structure of an IP address whitelist.
groupName	string	No	The name of the whitelist group. This parameter is required if you specify the `whiteIpGroup` parameter.	default
ips	array	No	The IP addresses in the whitelist group.
	string	No	An IP address or a CIDR block.	127.0.0.1
authentication	object	No	The authentication settings.
basicAuth	array<object>	No	The basic authentication settings.
	object	No	Basic authentication information.
username	string	No	The username. The default value is the application ID. This parameter cannot be modified.	test-123
password	string	No	The password.	******
privateNetwork	array<object>	No	The private network settings.
	array<object>	No	The structure for the private network settings.
type	string	No	The type of the private network endpoint. Valid values: PRIVATE_KIBANA: the IP address whitelist for private access to Kibana PRIVATE_ES: the IP address whitelist for private access to Elasticsearch	PRIVATE_ES
enabled	boolean	No	Specifies whether to enable private network access.	true
vpcId	string	No	The ID of the VPC to which the endpoint belongs.	vpc-bp1jy348ibzulk6hn****
pvlEndpointId	string	No	The endpoint ID.	ep-bp1id41dd116e52e****
whiteIpGroup	array<object>	No	The IP address whitelists.
	object	No	The structure of an IP address whitelist.
groupName	string	No	The name of the whitelist group. This parameter is required if you specify the `whiteIpGroup` parameter.	default
ips	array	No	The IP addresses in the whitelist group.
	string	No	An IP address or a CIDR block.	127.0.0.1
limiterInfo	object	No	The system limit settings. Note Modify these settings in the console. After you submit the changes, a specification approval ticket is generated.
limiters	array<object>	No	The list of limits.
	object	No	A limit.
maxValue	integer	No	The maximum value.	1
minValue	integer	No	The minimum value.	3
type	string	No	The type of the system limit.	MAX_CU_PER_SHARD
values	array	No	The list of limit values.
	string	No	A limit value.	true
applyReason	string	No	The reason for the application.	Apply for system limits.
contactInfo	string	No	The contact information, such as a phone number or an email address.	1370247****

Response elements

Element	Type	Description	Example
	object	The structure of the response body.
requestId	string	The request ID.	6B297235-FC5B-590D-8218-8A5ED90AAE99
result	object	The returned data.
instanceId	string	The instance ID of the application.	es-serverless-cn-8tr6u27483859****

Examples

Success response

JSON format

{
  "requestId": "6B297235-FC5B-590D-8218-8A5ED90AAE99",
  "result": {
    "instanceId": "es-serverless-cn-8tr6u27483859****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.