All Products
Search
Document Center

OpenSearch:ModifyAdvanceConfigFile

Last Updated:Jul 16, 2024

Modifies the advanced configurations.

Operation description

Method

put

URI

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

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}/advanced-configs/{configName}/file

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-2r42ostoc01
configNamestringYes

The configuration name.

ha-cn-zvp2ou1h801_online_config_edit
fileNamestringYes

The name of the file.

/qrs.json
bodyobjectNo

The request body.

contentstringNo

The file content.

"ha3"
variablesobjectNo

The variables.

objectNo

The variable information.

disableModifybooleanNo

Specifies whether the variable is not allowed to be modified.

false
isModifybooleanNo

Specifies whether the variable is modified.

false
valuestringNo

The variable value.

""
descriptionstringNo

The description of the variable.

""
templateValuestringNo

The template value of the variable.

""
typestringNo

The variable type. Valid values:

  • NORMAL: common variable
  • FUNCTION: function variable
NORMAL
funcValueobjectNo

The function variables.

funcClassNamestringNo

The class name of the function variable.

""
templatestringNo

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

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

id of request

93A9E542-8CF8-5BA6-99AB-94C0FE520429
resultobject

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