调用DescribeApps API获取应用版本列表-智能开放搜索 OpenSearch-阿里云

获取一个 OpenSearch 应用的版本列表。

接口说明

若已存在同名标准版应用，则创建新版本；
在新建版本情况下，autoSwitch 和 realtimeShared 也是必填的；
在新建版本情况下，quota 是自动从上一个版本继承的；
在新建版本情况下，修改 quota 是无效的。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:ListApp

list

*App

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	my_app_group_name

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID	77CAA411-0010-4DB9-82E2-1C384E590AFF
result	array<object>	返回结果
	array<object>	版本信息，参考： App	{}
id	string	组 ID	100302881
isCurrent	boolean	是否是在线版本。	12333
clusterName	string	集群名称	vpc_sh_domain_1
autoSwitch	boolean	是否自动切换	true
type	string	应用类型 standard 标准版 advance 老高级版（新应用不支持此类型） enhanced 新高级版	enhanced
description	string	描述	""
status	string	版本状态 ok 正常 stopped 暂停 frozen 已冻结 initializing 版本初始化中 unavailable 版本已失效 data_waiting 等待数据初始化 data_preparing 数据初始化中	normal
schema	object	应用结构
tables	object	表结构。
indexes	object	索引结构
filterFields	array	属性字段
	string	属性字段	id
searchFields	object	索引字段
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 内容
category	string	类型-standard 标准版-advance 老高级版（新应用不支持此类型）-enhanced 新高级版	-
name	string	英文名称	test
functions	object	搜索结果
service	array	功能 1
	string	功能 1	-
qp	array	信息 1
	string	信息 1	spellcheck
algo	array	结构 1
	string	结构 1	pop
schemas	array<object>	单表应用结构
	array<object>	单表应用结构
tables	object	表结构
indexes	object	索引结构
filterFields	array	属性字段
	string	属性字段	field1
searchFields	object	索引字段
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	表字段映射信息
plugins	object	字段数据处理插件插件名称（name） JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover 插件参数（parameters）： JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover
keyField	string	主键	id
schemaName	string	宽表名称	name
parameters	object	数据源信息
summaries	array<object>	搜索结果摘要配置
	array<object>	搜索结果摘要配置
name	string	分组名	fefault
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	包含功能
indexes	array	应用索引
	string	应用索引	default
active	boolean	是否默认规则	False
cluster	object	能力开放配置
maxTimeoutMS	integer	集群的超时时间，单位是 ms	750
maxQueryClauseLength	integer	query 字句最大长度	1024
interpretations	object	LLM 字段模型
prompts	array<object>	prompt 配置
	object	prompt 配置

示例

正常返回示例

JSON格式

{
  "requestId": "77CAA411-0010-4DB9-82E2-1C384E590AFF",
  "result": [
    {
      "id": "100302881",
      "isCurrent": true,
      "clusterName": "vpc_sh_domain_1",
      "autoSwitch": true,
      "type": "enhanced",
      "description": "\"\"",
      "status": "normal",
      "schema": {
        "tables": {
          "test": "test",
          "test2": 1
        },
        "indexes": {
          "filterFields": [
            "id"
          ],
          "searchFields": {
            "test": "test",
            "test2": 1
          }
        },
        "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": [
            "spellcheck"
          ],
          "algo": [
            "pop"
          ]
        }
      },
      "schemas": [
        {
          "tables": {
            "test": "test",
            "test2": 1
          },
          "indexes": {
            "filterFields": [
              "field1"
            ],
            "searchFields": {
              "test": "test",
              "test2": 1
            }
          },
          "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": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "plugins": {
            "test": "test",
            "test2": 1
          },
          "keyField": "id",
          "schemaName": "name",
          "parameters": {
            "test": "test",
            "test2": 1
          }
        }
      ],
      "summaries": [
        {
          "name": "fefault",
          "meta": [
            {
              "field": "field1",
              "len": 50,
              "element": "em",
              "ellipsis": "...",
              "snippet": "5"
            }
          ]
        }
      ],
      "queryProcessors": [
        {
          "name": "test",
          "domain": "GENERAL",
          "category": "\"\"",
          "processors": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "indexes": [
            "default"
          ],
          "active": true
        }
      ],
      "cluster": {
        "maxTimeoutMS": 750,
        "maxQueryClauseLength": 1024
      },
      "interpretations": {
        "test": "test",
        "test2": 1
      },
      "prompts": [
        {
          "test": "test",
          "test2": 1
        }
      ]
    }
  ]
}

错误码

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

变更历史

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