All Products
Search
Document Center

OpenSearch:ModifyFile

Last Updated:Jul 19, 2024

Modifies a file.

Operation description

Method

PUT

URI

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-i7m2ne76e02
indexNamestringYes

The index name.

automobile_vector
versionNamestringYes

The version name.

ha-cn-tl32m2c4u01@ha-cn-tl32m2c4u01_00@bj_vpc_domain_1@automobile_vector@index_config_edit
fileNamestringYes

The name of the file in the full path

/schemas/generation_schema.json
bodyobjectNo

The request body.

contentstringNo

The file content.

""
partitionintegerNo

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

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

id of request

89B968E6-1E41-58DF-BB25-5F98ECC759CE
resultobject

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 timeSummary of changesOperation
2022-01-12Add OperationView Change Details