Update OpenSearch Index Files with the ModifyFile API - OpenSearch - Alibaba Cloud - OpenSearch

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file?fileName=/root/test.txt

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

searchengine:ModifyFile

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

PUT /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
indexName	string	Yes	The index name.	test_api
versionName	string	Yes	The version name.	ha-cn-pl32rf0****_online_config_v1

Request parameters

Parameter	Type	Required	Description	Example
fileName	string	Yes	The full path of the file.	/schemas/generation_schema.json
body	object	No	The request body.	{\"desc\":\"new version\"}
content	string	No	The file content.	{\"partition\":1}
partition	integer	No	The number of shards.	1

Sample requests

PUT  /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt

{

  "partition": 1,

  "content": ""

}

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The request ID.	89B968E6-1E41-58DF-BB25-5F98ECC759CE
result	object	The index information.	{}

Sample responses

Sample success responses

{
 
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
 
  "result": {}
 
}

Examples

Success response

JSON format

{
  "requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE",
  "result": {}
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.