ModifyClusterOnlineConfig - OpenSearch - Alibaba Cloud Documentation Center

Modifies the online configuration of a cluster.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/cluster-online-config

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:ModifyClusterOnlineConfig		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request syntax

PUT /openapi/ha3/instances/{instanceId}/cluster-online-config HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-7mz2ougaw02
body	object	No	The request body.
config	object	No	The configuration information.
	integer	No	The version number of the configuration.	2
clusters	array	No	The cluster information.
cluster	string	No	The clusters.	[ "hz_pre_vpc_domain_1" ]

Sample requests

PUT /openapi/ha3/instances/ha3_instance_name/cluster-online-config

{
    "advancedConfigVersionId": 2,
    "clusters": [
      "hz_pre_vpc_domain_1"
    ]
}

Response parameters

Parameter	Type	Description	Example
	object	{}
requestId	string	The ID of the request	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	Map	{}

Sample responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.