ModifyAdvanceConfigFile - OpenSearch - Alibaba Cloud Documentation Center

Modifies the advanced configurations.

Operation description

Method

put

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file?fileName={fileName}

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

Request syntax

PUT /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/file HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42ostoc01
configName	string	Yes	The configuration name.	ha-cn-zvp2ou1h801_online_config_edit
fileName	string	Yes	The name of the file.	/qrs.json
body	object	No	The request body.
content	string	No	The file content.	"ha3"
variables	object	No	The variables.
	object	No	The variable information.
disableModify	boolean	No	Specifies whether the variable is not allowed to be modified.	false
isModify	boolean	No	Specifies whether the variable is modified.	false
value	string	No	The variable value.	""
description	string	No	The description of the variable.	""
templateValue	string	No	The template value of the variable.	""
type	string	No	The variable type. Valid values: NORMAL: common variable FUNCTION: function variable	NORMAL
funcValue	object	No	The function variables.
funcClassName	string	No	The class name of the function variable.	""
template	string	No	The template of the function variable.	""

Sample requests

PUT /openapi/ha3/instances/{instanceId}/advancedConfigs/{configName}/file?fileName=/root/test.txt

{

  "content": "",

  "variables": {

    "qrs_connection_timeout": {

      "description": "",

      "disableModify": false,

      "isModify": true,

      "type": "NORMAL",

      "value": "800"

    }

  }

}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	id of request	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	object	The result.	{}

Sample responses

Sample success responses

{
 
  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",
 
  "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.

Change history

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