全部产品
Search
文档中心

智能开放搜索 OpenSearch:ModifyAdvanceConfigFile - 修改词典

更新时间:Oct 16, 2024

修改词典。

接口说明

方法

PUT

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ModifyAdvanceConfigFile
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-pl32rf0****
configNamestring

配置名称

ha-cn-pl32rf0****_online_config_edit
fileNamestring

文件名

/qrs.json
bodyobject

请求体参数

contentstring

文件内容

{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
variablesobject

变量列表

object

子变量信息

disableModifyboolean

是否不允许修改

false
isModifyboolean

是否被修改过

false
valuestring

变量值

qrs_connection_timeout
descriptionstring

描述

超时时间
templateValuestring

模板值

800
typestring

类型:

  • NORMAL: 普通变量
  • FUNCTION:function 变量
NORMAL
funcValueobject

函数变量

funcClassNamestring

方法类名

ModifyFile
templatestring

模板

test-template

请求示例



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"

    }

  }

}

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

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

返回结果。

{}

返回示例

正确返回 

{

  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",

  "result": []

}

详情可参考响应结构

示例

正常返回示例

JSON格式

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": {}
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI查看变更详情