ModifyFile - OpenSearch - Alibaba Cloud Documentation Center

Modifies a file.

Operation description

Method

PUT

URI

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

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-i7m2ne76e02
indexName	string	Yes	The index name.	automobile_vector
versionName	string	Yes	The version name.	ha-cn-tl32m2c4u01@ha-cn-tl32m2c4u01_00@bj_vpc_domain_1@automobile_vector@index_config_edit
fileName	string	Yes	The name of the file in the full path	/schemas/generation_schema.json
body	object	No	The request body.
content	string	No	The file content.	""
partition	integer	No	The number of shards.	ds=20220713

Sample requests

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

{

  "partition": 1,

  "content": ""

}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	id of request	89B968E6-1E41-58DF-BB25-5F98ECC759CE
result	object	The information about the index	{}

Sample responses

Sample success responses

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details