DescribeApps - OpenSearch - Alibaba Cloud Documentation Center

Queries the versions of an OpenSearch application.

Operation description

If a Standard Edition application with the same name exists, a new version is created.
When you create a new version, the autoSwitch and realtimeShared parameters are required.
When you create a new version, the quota is inherited from the previous version.
When you create a new version, modifications to the quota do not take effect.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:ListApp

list

*App

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name or ID of the application group.	my_app_group_name

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request.	77CAA411-0010-4DB9-82E2-1C384E590AFF
result	array<object>	The response parameters.
	array<object>	The version information. For more information, see App.	{}
id	string	The ID of the application.	100302881
isCurrent	boolean	Indicates whether the version is an online version.	12333
clusterName	string	The name of the cluster.	vpc_sh_domain_1
autoSwitch	boolean	Indicates whether automatic switchover is enabled.	true
type	string	The type of the application. Valid values: standard: a Standard Edition application. advance: an Advanced Edition application of an old version. This edition is not supported for new applications. enhanced: a new version of Advanced Edition.	enhanced
description	string	The description.	""
status	string	The status of the version. Valid values: ok: The version is normal. stopped: The version is paused. frozen: The version is frozen. initializing: The version is being initialized. unavailable: The version is invalid. data_waiting: Data is pending initialization. data_preparing: Data is being initialized.	normal
schema	object	The application schema.
tables	object	The table schema.
indexes	object	The index schema.
filterFields	array	The attribute fields.
	string	The attribute field.	id
searchFields	object	The index fields.
routeField	string	The level-1 routing field.	field1
routeFieldValues	array	The hot data values of the level-1 routing field.
	string	The hot data value of the level-1 routing field.	routeFieldValues
secondRouteField	string	The level-2 routing field. This parameter takes effect only if the routeFieldValues parameter is configured. By default, the primary key of the wide table is used as the level-2 routing field.	field2
ttlField	object	The document time-to-live (TTL) settings.
name	string	The document TTL field.	text1
ttl	integer	The time to live (TTL). Unit: milliseconds.	1000
indexSortConfig	array<object>	The index sorting settings.
	object	The index sorting settings.
field	string	The sort field.	field1
direction	string	The sort order. Valid values: ASC DESC	DESC
name	string	The name of the wide table.	test
progressPercent	integer	The progress of data import in percentage. For example, a value of 83 indicates 83%.	100
fetchFields	array	The default display fields.
	string	The default display field.	{}
quota	object	The quota information.
spec	string	The specifications. Valid values: opensearch.share.junior: Basic opensearch.share.common: Shared general-purpose opensearch.share.compute: Shared compute-optimized opensearch.share.storage: Shared storage-optimized opensearch.private.common: Dedicated general-purpose opensearch.private.compute: Dedicated compute-optimized opensearch.private.storage: Dedicated storage-optimized	opensearch.share.common
qps	integer	The number of queries per second (QPS). This parameter is used in an earlier billing model.	5
docSize	integer	The storage capacity. Unit: GB.	1
computeResource	integer	The computing resources. Unit: logical compute unit (LCU).	20
domain	object	The industry. Valid values: GENERAL ECOMMERCE IT_CONTENT
category	string	The edition of the application. Valid values: standard (Standard Edition), advance (the legacy Premium Edition, which is not available for new applications), and enhanced (the new Premium Edition).	-
name	string	The name in English.	test
functions	object	The search features.
service	array	The service features.
	string	The service feature.	-
qp	array	The query processing features.
	string	Information about the query processor.	spellcheck
algo	array	Structure 1
	string	Structure 1	pop
schemas	array<object>	The schema of a non-partitioned table.
	array<object>	The schema of a non-partitioned table.
tables	object	The table schema.
indexes	object	The index schema.
filterFields	array	The attribute fields.
	string	The attribute field.	field1
searchFields	object	The index fields.
routeField	string	The level-1 routing field.	field1
routeFieldValues	array	The hot data values of the level-1 routing field.
	string	The hot data value of the level-1 routing field.	routeFieldValues
secondRouteField	string	The level-2 routing field. This parameter takes effect only if the routeFieldValues parameter is configured. By default, the primary key of the wide table is used as the level-2 routing field.	field2
ttlField	object	The document TTL settings.
name	string	The document TTL field.	fIeld1
ttl	integer	The time to live (TTL). Unit: milliseconds.	1000
indexSortConfig	array<object>	The index sorting settings.
	object	The index sorting settings.
field	string	The sort field.	fIeld1
direction	string	The sort order. Valid values: ASC DESC	DESC
name	string	The name of the wide table.	main
firstRanks	array<object>	The coarse-grained sorting settings.
	object	The coarse-grained sorting settings.
type	string	The expression type. Valid values: STRUCT: a structured expression. STRING (default): a custom formula. STRUCT: The content of the expression is a structure. STRING (default): You can configure a custom formula.	STRING
name	string	The name of the coarse-grained sorting expression.	test
description	string	The description.	描述
active	boolean	Indicates whether this is the default expression.	False
meta	any	The expression, which can be an array or a string.	String :"random()*100+now()"； Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ]
secondRanks	array<object>	The fine-grained sorting settings.
	object	The fine-grained sorting settings.
meta	any	The fine-grained sorting expression. You can define an expression that consists of fields, feature functions, and mathematical functions to implement complex sorting logic.	"cate_id > 0 and cate_id < 1000"
name	string	The name of the fine-grained sorting expression.	default
description	string	The description.	描述
active	boolean	Indicates whether this is the default expression.	False
dataSources	array<object>	The data source settings.
	array<object>	The data source settings.
tableName	string	The name of the table in the application.	main
type	string	The type of the data source. Valid values: rds odps opensearch polardb	rds
fields	array<object>	The field mappings.
	object	The field mappings.
plugins	object	The data processing plug-ins for fields. Plug-in name (name) JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover Plug-in parameters (parameters): JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover
keyField	string	The primary key.	id
schemaName	string	The name of the wide table.	name
parameters	object	The data source parameters.
summaries	array<object>	The search result summary settings.
	array<object>	The search result summary settings.
name	string	The name of the summary group.	fefault
meta	array<object>	The summary settings.
	object	The summary settings.
field	string	The field.	field1
len	integer	The length of the segment. Valid values: 1 to 300.	50
element	string	The HTML tag for highlighting.	em
ellipsis	string	The connector that is used to connect segments.	...
snippet	string	The number of segments. Valid values: 1 to 5.	5
queryProcessors	array<object>	The query analysis settings.
	array<object>	The query analysis settings.
name	string	The name of the query analysis rule.	test
domain	string	The industry. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
category	string	The industry category.	""
processors	array<object>	The features.
	object	The feature.
indexes	array	The indexes.
	string	The index.	default
active	boolean	Indicates whether this is the default rule.	False
cluster	object	The cluster settings.
maxTimeoutMS	integer	The timeout period for the cluster. Unit: ms.	750
maxQueryClauseLength	integer	The maximum length of the query clause.	1024
interpretations	object	The Large Language Model (LLM) settings for fields.
prompts	array<object>	The prompt settings.
	object	The prompt settings.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.