ModifyIndexPartition - OpenSearch - Alibaba Cloud Documentation Center

Modifies the information about index partitions.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/index-partition

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:ModifyIndexPartition		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request syntax

PUT /openapi/ha3/instances/{instanceId}/index-partition HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-7mz2ttxta01
body	object	No	The request body.
dataSourceName	string	No	The name of the data source.	test1
generation	long	No	The primary key.	1633293829
domainName	string	No	The data center.	pre_domain_1
indexInfos	array<object>	No	The index information.
indexInfo	object	No	The information about each index.
indexName	string	No	The index name.	atest2
partitionCount	integer	No	The number of shards.	3
parallelNum	integer	No	The concurrency. Default value: 1.	1

Example

PUT /openapi/ha3/instances/{instanceId}/index-partition

{
  "dataSourceName":"ha-cn-pl32n3bi904_d",
  "domainName":"pre_domain_1",
  "generation":"1633293829",
  "indexInfos":[
    {
      "indexName":"atest2",
      "partitionCount":2
    }
  ]
}

Response parameters

Parameter	Type	Description	Example
	object
requestId	string	id of request	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	object	Map	[]

Sample responses

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

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": []
}

Error codes

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