全部產品
Search

搜尋本產品

    OpenSearch：GetAdvanceConfig - 擷取詞典資訊

    文件中心

    OpenSearch：GetAdvanceConfig - 擷取詞典資訊

    更新時間：Dec 24, 2025

    擷取詞典資訊。

    介面說明

    方法

    GET

    URI

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

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    searchengine:GetAdvanceConfig

    get

    *Instance

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

    		 無 無

    請求文法

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

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    執行個體 ID

    ha-cn-pl32rf0****
    configName

    string

    是

    配置名稱

    ha-cn-pl32rf0****_offline_adv_edit

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    type

    string

    否

    • -ONLINE: 線上配置,

    • -ONLINE_CAVA: 線上 cava 配置,

    • -ONLINE_PLUGIN: 線上外掛程式,

    • -ONLINE_QUERY: 查詢配置,

    • -OFFLINE_DICT: 離線配置,

    • -OFFLINE_TABLE: 離線表,

    • -OFFLINE_COMMON: 離線配置,

    • -OFFLINE_PLUGIN: 離線外掛程式,

    • -OFFLINE_INDEX: 索引配置

    ONLINE

    請求樣本

    GET  /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    requestId

    string

    請求 ID

    E45380E8-994A-5402-9806-F114B3295FCF
    result

    object

    結果

    updateTime

    integer

    更新時間

    2024-05-21 16:05:26
    desc

    string

    描述

    自訂備忘資訊
    files

    array<object>

    檔案清單。

    object

    檔案資訊。

    name

    string

    名稱

    ha-cn-pl32rf0****_qrs
    fullPathName

    string

    檔案路徑

    /cluster
    isDir

    boolean

    是目錄

    true
    isTemplate

    boolean

    是容器

    true
    content

    string

    配置內容 http，git 請求時不為空白

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

    string

    配置內容的類型 (FILE, GIT, HTTP, ODPS)

    FILE
    name

    string

    配置名稱

    my_index
    status

    string

    配置狀態 (drafting: 草稿, used: 線上使用, unused: 未使用, trash: 刪除中)

    used

    返回樣本

    正確返回

    {
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name": "my_index",
    "status": "drafting",
    "updateTime": 1631070464000,
    "desc":"test",
    "files": [
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      },
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      }
    ]    
  }
}

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "updateTime": 0,
    "desc": "自訂備忘資訊",
    "files": [
      {
        "name": "ha-cn-pl32rf0****_qrs",
        "fullPathName": "/cluster",
        "isDir": true,
        "isTemplate": true
      }
    ],
    "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
    "contentType": "FILE",
    "name": "my_index",
    "status": "used"
  }
}

    錯誤碼

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

    變更歷史

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