DescribeApp API Reference for App Version Details - OpenSearch

Queries the information about a version of an OpenSearch application.

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:DescribeApp

get

*App

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	my_app_group_name
appId	integer	Yes	The version ID.	110116134

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.	{}
requestId	string	The request ID.	33477D76-C380-1D84-A4AD-043F52876CB1
result	object	The version information.	{}
id	string	The version ID.	100303063
isCurrent	boolean	Indices whether the version is an online version.	True
clusterName	string	The cluster name.	-
autoSwitch	boolean	Indicates whether the version is automatically switched to an online version.	true
type	string	The edition type. Valid values: standard: a standard edition application. advance: an advanced edition application of an old version. New versions are not supported for this edition. enhanced: an advanced edition application of a new version.	enhanced
description	string	The description of the version.	-
status	string	The status of the version. Valid values: ok: The version is normal. stopped: The version is suspended. frozen: The version is frozen. initializing: The version is being initialized. unavailable: The version is invalid. data_waiting: Data is to be initialized. data_preparing: Data is being initialized.	ok
schema	object	The schema of the application.	{}
tables	object	The table schema.	{ "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	The index schema.
filterFields	array	The attribute fields.
	string	The attribute field.	id
searchFields	object	The index fields.	{ "fields": ["title"], "analyzer": "chn_standard" }
routeField	string	The name of the level-1 routing field.	field1
routeFieldValues	array	The hot values of the level-1 routing field.
	string	The hot value of the level-1 routing field.	routeFieldValues
secondRouteField	string	The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.	field2
ttlField	object	The document clearing configurations.
name	string	The document time field.	text1
ttl	integer	The TTL. Unit: milliseconds.	1000
indexSortConfig	array<object>	The sort configurations.
	object	The sort configurations.
field	string	The sort field.	field1
direction	string	The sort method. 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 fields.	{}
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 computing opensearch.share.storage: shared storage opensearch.private.common: exclusive general-purpose opensearch.private.compute: exclusive computing opensearch.private.storage: exclusive storage	opensearch.share.common
qps	integer	The number of search requests per second. You are charged based on the number of search requests per second in the earlier billing model.	5
docSize	integer	The storage capacity. Unit: GB.	1
computeResource	integer	The computing resources. Unit: logical computing unit (LCU).	20
domain	object	The industry type. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
category	string	The type of the edition. Valid values: standard, advance, and enhanced. A value of standard indicates a standard edition. A value of advance indicates an advanced edition which is of an old version. New version is not supported for this edition. A value of enhanced indicates an advanced edition which is of a new version.	-
name	string	The name (in English).	test
functions	object	The search results.	{}
service	array	The description of each feature.	[]
	string	Feature 1.	-
qp	array	The information about the layout.	[]
	string	Information 1.	-
algo	array	The structure of the algorithm.	[]
	string	Structure 1.	-
schemas	array<object>	The multi-table schema.
	array<object>	The single-table schema.
tables	object	The table schema.	{ "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	The index schema.
filterFields	array	The attribute fields.
	string	The attribute field.	field1
searchFields	object	The index fields.	{ "fields": ["title"], "analyzer": "chn_standard" }
routeField	string	The name of the level-1 routing field.	field1
routeFieldValues	array	The hot values of the level-1 routing field.
	string	The hot value of the level-1 routing field.	routeFieldValues
secondRouteField	string	The name of the level-2 routing field. This parameter takes effect only when the routeFieldValues parameter is configured. By default, the wide-table primary key field is used as the level-2 routing field.	field2
ttlField	object	The document clearing configurations.
name	string	The document time field.	fIeld1
ttl	integer	The TTL. Unit: milliseconds.	1000
indexSortConfig	array<object>	The sort configurations.
	object	The sort configurations.
field	string	The sort field.	fIeld1
direction	string	The sort method. Valid values: ASC DESC	DESC
name	string	The name of the wide table.	main
firstRanks	array<object>	The configurations of rough sort.
	object	The configurations of rough sort.
type	string	The expression type. Valid values: STRUCT: The content of the expression is a structure. STRING (default): custom formula.	STRING
name	string	The name of the rough sort expression.	test
description	string	The description.	Description
active	boolean	Indicates whether the expression is the default one.	False
meta	any	The information about the expression. The information can be of the array or string type.	String :"random()*100+now()"; Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ]
secondRanks	array<object>	The configurations of fine sort.
	object	The configurations of fine sort.
meta	any	The fine sort expression. You can define an expression that contains fields, feature functions, and mathematical functions to implement complex sort logic.	"cate_id > 0 and cate_id < 1000"
name	string	The name of the fine sort expression.	default
description	string	The description.	Description
active	boolean	Indicates whether the expression is the default one.	False
dataSources	array<object>	The configurations of the data sources.
	array<object>	The configurations of the data source.
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 information about field mappings.
	object	The information about field mappings.	{ "id": "id" }
plugins	object	The plug-ins that are used for data processing. name: JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover parameters: JsonKeyValueExtractor MultiValueSpliter KeyValueExtractor StringCatenateExtractor HTMLTagRemover	{ "name": "JsonKeyValueExtractor", "parameters": { "key": "my_field" } }
keyField	string	The primary key.	id
schemaName	string	The name of the wide table.	name
parameters	object	The information about the data source.	{ "instanceId": "rds-instance-id", "dbName": "my_db", "dbTableName": "my_table", "dbUser": "my", "dbPassword": "my_passwd", "filter":"", "autoSync": true }
summaries	array<object>	The summary configurations of search results.
	array<object>	The summary configurations of search results.
name	string	The group name.	default
meta	array<object>	The summary configurations.
	object	The summary configurations.
field	string	The field.	field1
len	integer	The length of the segment. Valid values: 1 to 300.	50
element	string	The element that is used 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 intent understanding configurations.
	array<object>	The query intent understanding configurations.
name	string	The rule name.	test
domain	string	The industry type. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
category	string	The industry category.	""
processors	array<object>	The features.
	object	The features.	{ "name": "stop_word", "useSystemDictionary": true, "interventionDictionary": "my_dict", "ignoreSpace": true }
indexes	array	Then index range.
	string	The index.	default
active	boolean	Indicates whether the rule is the default one.	False
cluster	object	The capability opening configurations.
maxTimeoutMS	integer	The timeout period. Unit: milliseconds.	750
maxQueryClauseLength	integer	The maximum length of the query clause.	1024
interpretations	object	The industry model module.	[ { "table": "table1", "fields": [ { "name": "field1", "interpretation": "title" }, { "name": "field2", "interpretation": "number" } ] } ]
prompts	array<object>	The prompt configurations.
	object	The prompt configurations.	{ "parameters" : [ { "name" : "docs", "value" : "docContent concatenation method,For example, the current qwenof ' \n${doc}\n \n" } ], "messages":[ { "role" : "role_name,Whether to limit it to only system, user, assistant,Or allow users to fill in freely", "content" : "User-definedpromptcontent,Can be used in ${parameter_key} totableIndicates the content expected to be dynamically replaced,See the following instructions for specific replacement rules" } ] }

Examples

Success response

JSON format

{
  "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": "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": "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": "title"
          },
          {
            "name": "field2",
            "interpretation": "number"
          }
        ]
      }
    ],
    "prompts": [
      {
        "parameters": [
          {
            "name": "docs",
            "value": "docContent concatenation method,For example, the current qwenof '\n${doc}\n\n"
          }
        ],
        "messages": [
          {
            "role": "role_name,Whether to limit it to only system, user, assistant,Or allow users to fill in freely",
            "content": "User-definedpromptcontent,Can be used in ${parameter_key} totableIndicates the content expected to be dynamically replaced,See the following instructions for specific replacement rules"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.