全部产品
Search

搜索本产品

    智能开放搜索 OpenSearch：ModifyClusterOfflineConfig - 修改集群的配置信息

    文档中心

    智能开放搜索 OpenSearch：ModifyClusterOfflineConfig - 修改集群的配置信息

    更新时间：Aug 27, 2026

    修改集群的配置信息。

    接口说明

    方法

    PUT

    URI

    /openapi/ha3/instances/{instanceId}/cluster-offline-config

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    searchengine:ModifyClusterOfflineConfig

    update

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 无 无

    请求语法

    PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config HTTP/1.1

    路径参数

    名称

    类型

    必填

    描述

    示例值
    instanceId

    string

    是

    实例 ID

    ha-cn-pl32rf0****

    请求参数

    名称

    类型

    必填

    描述

    示例值
    body

    object

    否

    请求结构。

    {}
    dataSourceName

    string

    否

    数据源名称

    ha-cn-pl32rf0****_test_api
    dataSourceType

    string

    否

    数据源类型 (odps: maxComputer, swift: swift, unKnow)

    odps
    domain

    string

    否

    数据源部署

    vpc_hz_domain_1
    config

    object

    否

    key:配置名称

    integer

    否

    value:配置版本号

    1
    partition

    string

    否

    对于 odps 数据源触发全量时必传

    ds=20211202
    dataTimeSec

    integer

    否

    对于 API 推送数据源触发全量时必传

    1640867288
    buildMode

    string

    否

    索引重建方式 (api: API 方式推送数据源, indexRecover: 从索引中恢复数据源)

    indexRecover
    generation

    integer

    否

    索引全量版本

    160142641
    pushMode

    string

    否

    推送配置方式: 默认仅推送配置

    PUSH_ONLY
    名称是否必须类型描述
    dataSource是String数据源名称
    domain是String数据源部署
    indexes是Object索引结构的描述信息
    advancedConfigVersionId是Integer高级配置的版本 id
    triggerBuild是booleantrue 推送配置并触发索引重建 false 配置等待下一次索引重建后生效
    buildMode否Integer重建 index 方式 api:默认方式 indexRecover:索引中恢复数据源 （目前只有数据源类型为 hdfs 必填）
    generation否Long历史回流 ID
    partition否String索引重建选择的数据源的数据分区，当触发 odps 索引重建时必传
    dataTimeSec否Integerint 类型，秒级时间戳，表示 API 推送数据源触发重建的数据时间，API 推送触发重建时必填项
    dataSourceType否Enum当 triggerBuild=true 时必传（odps 或 swift）

    请求示例

    PUT /openapi/ha3/instances/ha3_instance_name/cluster-offline-config

    {
    "dataSource": "test1",
    "domain": "xx",
    "indexes": [
        {
            "name": "index1",
            "versionId": 1
        },
        {
            "name": "index2",
            "versionId": 1
        }
    ],
    "advancedConfigVersionId": 2,
    "triggerBuild": true,
    "partition": "20201010", //odps 触发重建时必填
    "dataSourceType": "odps", // odps 或 swift，必填项，不传报错
    "dataTimeSec": 1640867288 //int 类型，秒级时间戳，表示 API 推送数据源触发重建的数据时间，API 推送触发重建时必填项
  
}

    返回参数

    名称

    类型

    描述

    示例值

    object

    requestId

    string

    请求 ID

    E7B7D598-B080-5C8E-AA35-D43EC0D5F886
    result

    object

    返回结果。

    {}

    返回示例

    {
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

    详情可参考响应结构

    示例

    正常返回示例

    JSON格式

    {
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

    错误码

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

    变更历史

    更多信息，参考变更详情。