全部產品
Search

搜尋本產品

    OpenSearch：ModifyClusterOfflineConfig - 修改叢集的配置資訊

    文件中心

    OpenSearch：ModifyClusterOfflineConfig - 修改叢集的配置資訊

    更新時間：Dec 24, 2025

    修改叢集的配置資訊。

    介面說明

    方法

    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": {}
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。