全部产品
Search
文档中心

智能开放搜索 OpenSearch:PublishAdvanceConfig - 发布高级版本

更新时间:Oct 16, 2024

发布高级版本。

接口说明

方法

POST

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish

调试

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

授权信息

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

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

请求语法

POST /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish HTTP/1.1

请求参数

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

实例 ID

ha-cn-pl32rf0****
configNamestring

配置名称

ha-cn-pl32rf0****_online_config_v3
bodyobject

请求结构。

descstring

高级配置描述信息

自定义配置
filesarray<object>

文件信息

object

文件信息

ossPathstring

oss 文件路径

oss://opensearch/test.json
operateTypestring

操作类型:UPDATE:更新;DELETE:删除;默认 UPDATE

UPDATE
parentFullPathstring

上级文件路径

/
fileNamestring

文件名称

vector_question_schema.json
dirNamestring

目录名称。

/clusters
configobject

高级配置信息

contentstring

文件内容

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

变量列表

object

变量

descriptionstring

变量描述

自定义变量
disableModifyboolean

是否可被用户修改

true
isModifyboolean

变量是否被修改过

true
typestring

类型:普通变量-NORMAL; function 变量-FUNCTION

NORMAL
valuestring

变量值

test

请求示例

POST /openapi/ha3/instances/ose-test1/advanced-configs/test/actions/publish

{
    "desc": "new version"
}

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

10D5E615-69F7-5F49-B850-00169ADE513C
resultobject

返回结果。

{}

返回示例

正确返回

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

详情可参考响应结构

示例

正常返回示例

JSON格式

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {}
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-16API 内部配置变更,不影响调用查看变更详情
2022-01-12新增 OpenAPI查看变更详情