全部產品
Search
文件中心

OpenSearch:DescribeApp - 查看一個應用版本詳情

更新時間:Dec 23, 2025

查看一個 OpenSearch 應用版本詳情。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

opensearch:DescribeApp

get

*App

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

請求文法

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId} HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

appGroupIdentity

string

應用程式名稱

my_app_group_name

appId

integer

版本 ID

110116134

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱

類型

描述

樣本值

object

響應體

{}

requestId

string

請求 ID

33477D76-C380-1D84-A4AD-043F52876CB1

result

object

版本資訊

{}

id

string

版本 ID

100303063

isCurrent

boolean

是否是線上版本。

True

clusterName

string

叢集名稱

-

autoSwitch

boolean

是否自動切換

true

type

string

版本類型

  • standard 標準版

  • advance 老進階版(新應用不支援此類型)

  • enhanced 新進階版

enhanced

description

string

版本描述

-

status

string

版本狀態

  • ok 正常

  • stopped 暫停

  • frozen 已凍結

  • initializing 版本初始化中

  • unavailable 版本已失效

  • data_waiting 等待資料初始化

  • data_preparing 資料初始化中

ok

schema

object

應用結構

{}

tables

object

表結構。

{ "primaryTable": true, "name": "main", "fields": { "id": { "name": "id", "type": "LITERAL", "primaryKey": true }, "title": { "name": "title", "type": "TEXT", "primaryKey": false }, "buy": { "name": "buy", "type": "INT", "primaryKey": false }, "cate_id": { "name": "cate_id", "type": "INT", "primaryKey": false }, "cate_name": { "name": "cate_name", "type": "LITERAL", "primaryKey": false } } }

indexes

object

索引結構

filterFields

array

屬性欄位集合

string

屬性欄位

id

searchFields

object

索引欄位

{ "fields": ["title"], "analyzer": "chn_standard" }

routeField

string

一級分欄欄位名稱

field1

routeFieldValues

array

一級分欄欄位熱點值

string

一級分欄欄位熱點值

routeFieldValues

secondRouteField

string

二級分欄欄位名稱(若且唯若配置有 routeFieldValues 時生效,預設使用寬表主鍵)

field2

ttlField

object

文檔清理配置

name

string

文檔清理欄位

text1

ttl

integer

存活時間(毫秒)

1000

indexSortConfig

array<object>

倒排索引配置

object

倒排索引配置

field

string

排序欄位

field1

direction

string

排序方式

  • ASC

  • DESC

DESC

name

string

寬表表名

test

progressPercent

integer

資料匯入進度百分比(如 83 代表 83%)

100

fetchFields

array

預設展示欄位

[]

string

預設展示欄位

{}

quota

object

配額資訊

{}

spec

string

規格

  • opensearch.share.junior 入門型

  • opensearch.share.common 共用通用型

  • opensearch.share.compute 共用計算型

  • opensearch.share.storage 共用儲存型

  • opensearch.private.common 獨享通用型

  • opensearch.private.compute 獨享計算型

  • opensearch.private.storage 獨享儲存型

opensearch.share.common

qps

integer

搜尋請求(單位:次/秒)(老計費模型使用)

5

docSize

integer

儲存容量(單位:GB)

1

computeResource

integer

計算資源(單位:LCU)

20

domain

object

行業類型

  • GENERAL 通用

  • ECOMMERCE 電商

  • IT_CONTENT IT 內容

GENERAL

category

string

類型-standard 標準版-advance 老進階版(新應用不支援此類型)-enhanced 新進階版

-

name

string

英文名稱

test

functions

object

搜尋結果

{}

service

array

各個功能說明

[]

string

功能 1

-

qp

array

布局資訊

[]

string

資訊 1

-

algo

array

演算法結構

[]

string

結構 1

-

schemas

array<object>

多表應用結構

array<object>

單表應用結構

tables

object

表結構

{ "primaryTable": true, "name": "main", "fields": { "id": { "name": "id", "type": "LITERAL", "primaryKey": true }, "title": { "name": "title", "type": "TEXT", "primaryKey": false }, "buy": { "name": "buy", "type": "INT", "primaryKey": false }, "cate_id": { "name": "cate_id", "type": "INT", "primaryKey": false }, "cate_name": { "name": "cate_name", "type": "LITERAL", "primaryKey": false } } }

indexes

object

索引結構

filterFields

array

屬性欄位集合

string

屬性欄位

field1

searchFields

object

索引欄位

{ "fields": ["title"], "analyzer": "chn_standard" }

routeField

string

一級分欄欄位名稱

field1

routeFieldValues

array

一級分欄欄位熱點值

string

一級分欄欄位熱點值

routeFieldValues

secondRouteField

string

二級分欄欄位名稱(若且唯若配置有 routeFieldValues 時生效,預設使用寬表主鍵)

field2

ttlField

object

文檔清理配置

name

string

文檔時間欄位

fIeld1

ttl

integer

存活時間(毫秒)

1000

indexSortConfig

array<object>

倒排索引配置

object

倒排索引配置

field

string

排序欄位

fIeld1

direction

string

排序方式

  • ASC

  • DESC

DESC

name

string

寬表表名

main

firstRanks

array<object>

粗排配置

object

粗排配置

type

string

運算式類型

STRUCT 結構化, 預設值- STRING 自訂公式

STRING

name

string

粗排名稱

test

description

string

描述

描述

active

boolean

是否是預設運算式

False

meta

any

運算式資訊(Array 或 String)

String :"random()*100+now()"; Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ]

secondRanks

array<object>

精排配置

object

精排配置

meta

any

精排運算式(可以編寫包含欄位、算分特徵和數學函數的運算式,實現複雜的排序邏輯)

"cate_id > 0 and cate_id < 1000"

name

string

精排名稱

default

description

string

描述

描述

active

boolean

是否是預設運算式

False

dataSources

array<object>

資料來源配置

array<object>

資料來源配置

tableName

string

應用表名

main

type

string

資料來源類型

  • rds

  • odps

  • opensearch

  • polardb

rds

fields

array<object>

表欄位對應資訊

object

表欄位對應資訊

{ "id": "id" }

plugins

object

欄位資料處理外掛程式

外掛程式名稱(name)

  • JsonKeyValueExtractor

  • MultiValueSpliter

  • KeyValueExtractor

  • StringCatenateExtractor

  • HTMLTagRemover

外掛程式參數(parameters):

  • JsonKeyValueExtractor

  • MultiValueSpliter

  • KeyValueExtractor

  • StringCatenateExtractor

  • HTMLTagRemover

{ "name": "JsonKeyValueExtractor", "parameters": { "key": "my_field" } }

keyField

string

主鍵

id

schemaName

string

寬表名稱

name

parameters

object

資料來源資訊

{ "instanceId": "rds-instance-id", "dbName": "my_db", "dbTableName": "my_table", "dbUser": "my", "dbPassword": "my_passwd", "filter":"", "autoSync": true }

summaries

array<object>

搜尋結果摘要配置

array<object>

搜尋結果摘要配置

name

string

分組名

default

meta

array<object>

摘要配置

object

摘要配置

field

string

欄位

field1

len

integer

片段長度,取值區間:[1-300]

50

element

string

飄紅標籤

em

ellipsis

string

片段連結符

...

snippet

string

片段數量,取值區間:[1-5]

5

queryProcessors

array<object>

查詢意圖理解配置

array<object>

查詢意圖理解配置

name

string

規則名稱

test

domain

string

行業類型

  • GENERAL 通用

  • ECOMMERCE 電商

  • IT_CONTENT IT 內容

GENERAL

category

string

行業垂類

""

processors

array<object>

包含功能

object

包含功能

{ "name": "stop_word", "useSystemDictionary": true, "interventionDictionary": "my_dict", "ignoreSpace": true }

indexes

array

應用的索引範圍

string

應用索引

default

active

boolean

是否預設規則

False

cluster

object

能力開放配置

maxTimeoutMS

integer

叢集的逾時時間,單位是 ms

750

maxQueryClauseLength

integer

query 字句最大長度

1024

interpretations

object

LLM 欄位模型

[ { "table": "table1", "fields": [ { "name": "field1", "interpretation": "標題" }, { "name": "field2", "interpretation": "編號" } ] } ]

prompts

array<object>

LLM prompt 配置

object

prompt 配置

{ "parameters" : [ { "name" : "docs", "value" : "doc內容的拼接方式,比如現在的 qwen的 '

\n${doc}\n
\n" } ], "messages":[ { "role" : "role_name,這裡是否需要限定只能是 system, user, assistant,還是可以讓使用者隨意填寫", "content" : "使用者佈建的prompt內容,裡面可以使用 ${parameter_key} 來表示期望動態替換的內容,具體替換規則參考下面說明" } ] }

樣本

正常返回樣本

JSON格式

{
  "requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
  "result": {
    "id": "100303063",
    "isCurrent": true,
    "clusterName": "-",
    "autoSwitch": true,
    "type": "enhanced",
    "description": "-",
    "status": "ok",
    "schema": {
      "tables": {
        "primaryTable": true,
        "name": "main",
        "fields": {
          "id": {
            "name": "id",
            "type": "LITERAL",
            "primaryKey": true
          },
          "title": {
            "name": "title",
            "type": "TEXT",
            "primaryKey": false
          },
          "buy": {
            "name": "buy",
            "type": "INT",
            "primaryKey": false
          },
          "cate_id": {
            "name": "cate_id",
            "type": "INT",
            "primaryKey": false
          },
          "cate_name": {
            "name": "cate_name",
            "type": "LITERAL",
            "primaryKey": false
          }
        }
      },
      "indexes": {
        "filterFields": [
          "id"
        ],
        "searchFields": {
          "fields": [
            "title"
          ],
          "analyzer": "chn_standard"
        }
      },
      "routeField": "field1",
      "routeFieldValues": [
        "routeFieldValues"
      ],
      "secondRouteField": "field2\n",
      "ttlField": {
        "name": "text1\n",
        "ttl": 1000
      },
      "indexSortConfig": [
        {
          "field": "field1",
          "direction": "DESC"
        }
      ],
      "name": "test"
    },
    "progressPercent": 100,
    "fetchFields": [
      "{}"
    ],
    "quota": {
      "spec": "opensearch.share.common",
      "qps": 5,
      "docSize": 1,
      "computeResource": 20
    },
    "domain": {
      "category": "-",
      "name": "test",
      "functions": {
        "service": [
          "-"
        ],
        "qp": [
          "-"
        ],
        "algo": [
          "-"
        ]
      }
    },
    "schemas": [
      {
        "tables": {
          "primaryTable": true,
          "name": "main",
          "fields": {
            "id": {
              "name": "id",
              "type": "LITERAL",
              "primaryKey": true
            },
            "title": {
              "name": "title",
              "type": "TEXT",
              "primaryKey": false
            },
            "buy": {
              "name": "buy",
              "type": "INT",
              "primaryKey": false
            },
            "cate_id": {
              "name": "cate_id",
              "type": "INT",
              "primaryKey": false
            },
            "cate_name": {
              "name": "cate_name",
              "type": "LITERAL",
              "primaryKey": false
            }
          }
        },
        "indexes": {
          "filterFields": [
            "field1"
          ],
          "searchFields": {
            "fields": [
              "title"
            ],
            "analyzer": "chn_standard"
          }
        },
        "routeField": "field1\n",
        "routeFieldValues": [
          "routeFieldValues"
        ],
        "secondRouteField": "field2",
        "ttlField": {
          "name": "fIeld1",
          "ttl": 1000
        },
        "indexSortConfig": [
          {
            "field": "fIeld1",
            "direction": "DESC"
          }
        ],
        "name": "main"
      }
    ],
    "firstRanks": [
      {
        "type": "STRING",
        "name": "test",
        "description": "描述",
        "active": true,
        "meta": "String :\"random()*100+now()\";\nArray: [\n    {\n      \"attribute\": \"static_bm25()\",\n      \"arg\": \"\",\n      \"weight\": 10\n    }\n  ]"
      }
    ],
    "secondRanks": [
      {
        "meta": "\"cate_id > 0 and cate_id < 1000\"\n",
        "name": "default\n",
        "description": "描述",
        "active": true
      }
    ],
    "dataSources": [
      {
        "tableName": "main",
        "type": "rds",
        "fields": [
          {
            "id": "id"
          }
        ],
        "plugins": {
          "name": "JsonKeyValueExtractor",
          "parameters": {
            "key": "my_field"
          }
        },
        "keyField": "id",
        "schemaName": "name",
        "parameters": {
          "instanceId": "rds-instance-id",
          "dbName": "my_db",
          "dbTableName": "my_table",
          "dbUser": "my",
          "dbPassword": "my_passwd",
          "filter": "",
          "autoSync": true
        }
      }
    ],
    "summaries": [
      {
        "name": "default",
        "meta": [
          {
            "field": "field1",
            "len": 50,
            "element": "em",
            "ellipsis": "...",
            "snippet": "5"
          }
        ]
      }
    ],
    "queryProcessors": [
      {
        "name": "test",
        "domain": "GENERAL",
        "category": "\"\"",
        "processors": [
          {
            "name": "stop_word",
            "useSystemDictionary": true,
            "interventionDictionary": "my_dict",
            "ignoreSpace": true
          }
        ],
        "indexes": [
          "default"
        ],
        "active": true
      }
    ],
    "cluster": {
      "maxTimeoutMS": 750,
      "maxQueryClauseLength": 1024
    },
    "interpretations": [
      {
        "table": "table1",
        "fields": [
          {
            "name": "field1",
            "interpretation": "標題"
          },
          {
            "name": "field2",
            "interpretation": "編號"
          }
        ]
      }
    ],
    "prompts": [
      {
        "parameters": [
          {
            "name": "docs",
            "value": "doc內容的拼接方式,比如現在的 qwen的 '\n${doc}\n\n"
          }
        ],
        "messages": [
          {
            "role": "role_name,這裡是否需要限定只能是 system, user, assistant,還是可以讓使用者隨意填寫",
            "content": "使用者佈建的prompt內容,裡面可以使用 ${parameter_key} 來表示期望動態替換的內容,具體替換規則參考下面說明"
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情