Retrieves the versions of an OpenSearch application.
Operation description
If a standard edition application with the same name already exists, a new version is created.
When creating a new version, autoSwitch and realtimeShared are also required.
When creating a new version, the quota is automatically inherited from the previous version.
When creating a new version, modifying the quota has no effect.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
opensearch:ListApp |
list |
*App
|
None | 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 of the application. |
my_app_group_name |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body for a successful request. |
||
| requestId |
string |
The request ID. |
77CAA411-0010-4DB9-82E2-1C384E590AFF |
| result |
array<object> |
The returned result. |
|
|
array<object> |
The version information. For more information, see App. |
{} |
|
| id |
string |
The group ID. |
100302881 |
| isCurrent |
boolean |
Indicates whether this is the online version. |
12333 |
| autoSwitch |
boolean |
Indicates whether automatic switchover is enabled. |
true |
| type |
string |
The application type. Valid values:
|
enhanced |
| description |
string |
The description. |
"" |
| status |
string |
The version status. Valid values:
|
normal |
| realtimeShared |
boolean |
Indicates whether the real-time stream is shared. |
|
| schema |
object |
The application schema. |
|
| tables |
object |
The table schema. |
|
| indexes |
object |
The index schema. |
|
| filterFields |
array |
The attribute fields. |
|
|
string |
The attribute fields. |
id |
|
| searchFields |
object |
The index fields. |
|
| routeField |
string |
The name of the primary routing field. |
field1 |
| routeFieldValues |
array |
The hot values of the primary routing field. |
|
|
string |
The hot values of the primary routing field. |
routeFieldValues |
|
| secondRouteField |
string |
The name of the secondary routing field. This field takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used. |
field2 |
| ttlField |
object |
The document cleanup configuration. |
|
| name |
string |
The document cleanup field. |
text1 |
| ttl |
integer |
The time-to-live (TTL) in milliseconds. |
1000 |
| indexSortConfig |
array<object> |
The inverted index configuration. |
|
|
object |
The inverted index configuration. |
||
| field |
string |
The sort field. |
field1 |
| direction |
string |
The sort order. Valid values:
|
DESC |
| name |
string |
The name of the wide table. |
test |
| fetchFields |
array |
The default display fields. |
|
|
string |
The default display fields. |
{} |
|
| domain |
object |
The industry type. Valid values:
|
|
| category |
string |
The type. Valid values: standard (Standard Edition), advance (Legacy Advanced Edition, not supported for new applications), and enhanced (New Advanced Edition). |
- |
| name |
string |
The English name. |
test |
| functions |
object |
The search results. |
|
| service |
array |
Feature 1. |
|
|
string |
Feature 1. |
- |
|
| qp |
array |
Information 1. |
|
|
string |
Information 1. |
spellcheck |
|
| algo |
array |
Structure 1. |
|
|
string |
Structure 1. |
pop |
|
| schemas |
array<object> |
The single-table application schema. |
|
|
array<object> |
The single-table application schema. |
||
| tables |
object |
The table schema. |
|
| indexes |
object |
The index schema. |
|
| filterFields |
array |
The attribute fields. |
|
|
string |
The attribute fields. |
field1 |
|
| searchFields |
object |
The index fields. |
|
| routeField |
string |
The name of the primary routing field. |
field1 |
| routeFieldValues |
array |
The hot values of the primary routing field. |
|
|
string |
The hot values of the primary routing field. |
routeFieldValues |
|
| secondRouteField |
string |
The name of the secondary routing field. This field takes effect only when routeFieldValues is configured. By default, the primary key of the wide table is used. |
field2 |
| ttlField |
object |
The document cleanup configuration. |
|
| name |
string |
The document time field. |
fIeld1 |
| ttl |
integer |
The time-to-live (TTL) in milliseconds. |
1000 |
| indexSortConfig |
array<object> |
The inverted index configuration. |
|
|
object |
The inverted index configuration. |
||
| field |
string |
The sort field. |
fIeld1 |
| direction |
string |
The sort order. Valid values:
|
DESC |
| name |
string |
The name of the wide table. |
main |
| firstRanks |
array<object> |
The rough sort configuration. |
|
|
object |
The rough sort configuration. |
||
| type |
string |
The expression type. Valid values:
|
STRING |
| name |
string |
The rough sort name. |
test |
| description |
string |
The description. |
Description |
| active |
boolean |
Indicates whether this is the default expression. |
False |
| meta |
any |
The expression information, which can be an array or a string. |
String :"random()*100+now()"; Array: [ { "attribute": "static_bm25()", "arg": "", "weight": 10 } ] |
| created |
integer |
The timestamp when the rough sort expression was created. |
1590977140 |
| updated |
integer |
The timestamp when the rough sort expression was updated. |
1590977140 |
| secondRanks |
array<object> |
The fine sort configuration. |
|
|
object |
The fine sort configuration. |
||
| meta |
any |
The fine sort expression. You can write expressions that include fields, scoring features, and mathematical functions to implement complex sorting logic. |
"cate_id > 0 and cate_id < 1000" |
| name |
string |
The fine sort name. |
default |
| description |
string |
The description. |
Description |
| active |
boolean |
Indicates whether this is the default expression. |
False |
| isDefault |
boolean |
Indicates whether this is the default fine sort expression. |
|
| created |
integer |
The timestamp when the fine sort expression was created. |
1593679894 |
| updated |
integer |
The timestamp when the fine sort expression was updated. |
1593679894 |
| dataSources |
array<object> |
The data source configuration. |
|
|
array<object> |
The data source configuration. |
||
| tableName |
string |
The application table name. |
main |
| type |
string |
The data source type. Valid values:
|
rds |
| fields |
array<object> |
The table field mapping information. |
|
|
object |
The table field mapping information. |
||
| plugins |
object |
The data processing plugins for fields. Plugin name (name):
Plugin parameters (parameters):
|
|
| keyField |
string |
The primary key. |
id |
| schemaName |
string |
The wide table name. |
name |
| parameters |
object |
The data source information. |
|
| summaries |
array<object> |
The search result summary configuration. |
|
|
array<object> |
The search result summary configuration. |
||
| name |
string |
The group name. |
fefault |
| meta |
array<object> |
The summary configuration. |
|
|
object |
The summary configuration. |
||
| field |
string |
The field. |
field1 |
| len |
integer |
The snippet length. Valid values: 1 to 300. |
50 |
| element |
string |
The HTML tag for highlight. |
em |
| ellipsis |
string |
The snippet connector. |
... |
| snippet |
string |
The number of snippets. Valid values: 1 to 5. |
5 |
| queryProcessors |
array<object> |
The query intention recognition configuration. |
|
|
array<object> |
The query intention recognition configuration. |
||
| name |
string |
The rule name. |
test |
| domain |
string |
The industry type. Valid values:
|
GENERAL |
| category |
string |
The industry vertical. |
"" |
| processors |
array<object> |
The included features. |
|
|
object |
The included features. |
||
| indexes |
array |
The application index. |
|
|
string |
The application index. |
default |
|
| active |
boolean |
Indicates whether the rule is the default rule. |
False |
| prompts |
array<object> |
The prompt configuration. |
|
|
object |
The prompt configuration. |
||
| cluster |
object |
The open capability configuration. |
|
| maxTimeoutMS |
integer |
The timeout period for the cluster, in milliseconds. |
750 |
| maxQueryClauseLength |
integer |
The maximum length of the query clause. |
1024 |
| vectorIndexConfigs |
array<object> |
The advanced configuration of the dedicated vector index. |
|
|
object |
The configuration item for the advanced configuration of the dedicated vector index. |
||
| chunkModels |
array<object> |
Specifies the chunking method used by the LLM application version. |
|
|
object |
The chunking method configuration item. |
||
| imageContentRecognizerModels |
array<object> |
Specifies the image content recognition model used by the LLM application version. |
|
|
object |
The configuration item for the image content recognition model. |
||
| textEmbeddingModel |
string |
Specifies the text embedding model used by the LLM application version. |
ops-text-embedding-002 |
| textSparseEmbeddingModel |
string |
Specifies the sparse vector model used by the LLM application version. |
ops-text-sparse-embedding-001 |
| interpretations |
array<object> |
The LLM field model. |
|
|
object |
The description of the LLM table field. |
||
| configItems |
array<object> |
The list of configuration items. |
|
|
object |
The configuration item. |
||
| switchTime |
integer |
The time when the version was switched online. |
0 |
| quota |
object |
The quota information. |
|
| usedQps |
integer |
The number of used search requests (legacy billing model). |
100 |
| qps |
integer |
The search requests per second (legacy billing model). |
5 |
| usedDocSize |
integer |
The used storage capacity. |
1024 |
| docSize |
integer |
The storage capacity, in GB. |
1 |
| usedComputeResource |
integer |
The used compute resources. |
100 |
| computeResource |
integer |
The compute resources, in LCUs. |
20 |
| spec |
string |
The specification. Valid values:
|
opensearch.share.common |
| progressPercent |
integer |
The data import progress percentage. For example, 83 indicates 83%. |
100 |
| updated |
integer |
The timestamp of the last update to the application version. |
1234567891 |
| created |
integer |
The timestamp when the version was created. |
1590486119 |
Examples
Success response
JSON format
{
"requestId": "77CAA411-0010-4DB9-82E2-1C384E590AFF",
"result": [
{
"id": "100302881",
"isCurrent": true,
"autoSwitch": true,
"type": "enhanced",
"description": "\"\"",
"status": "normal",
"realtimeShared": false,
"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"
},
"fetchFields": [
"{}"
],
"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": "Description",
"active": true,
"meta": "String :\"random()*100+now()\";\nArray: [\n {\n \"attribute\": \"static_bm25()\",\n \"arg\": \"\",\n \"weight\": 10\n }\n ]",
"created": 1590977140,
"updated": 1590977140
}
],
"secondRanks": [
{
"meta": "\"cate_id > 0 and cate_id < 1000\"\n",
"name": "default\n",
"description": "Description",
"active": true,
"isDefault": false,
"created": 1593679894,
"updated": 1593679894
}
],
"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
}
],
"prompts": [
{
"test": "test",
"test2": 1
}
],
"cluster": {
"maxTimeoutMS": 750,
"maxQueryClauseLength": 1024,
"vectorIndexConfigs": [
{
"test": "test",
"test2": 1
}
],
"chunkModels": [
{
"test": "test",
"test2": 1
}
],
"imageContentRecognizerModels": [
{
"test": "test",
"test2": 1
}
],
"textEmbeddingModel": "ops-text-embedding-002",
"textSparseEmbeddingModel": "ops-text-sparse-embedding-001"
},
"interpretations": [
{
"test": "test",
"test2": 1
}
],
"configItems": [
{
"test": "test",
"test2": 1
}
],
"switchTime": 0,
"quota": {
"usedQps": 100,
"qps": 5,
"usedDocSize": 1024,
"docSize": 1,
"usedComputeResource": 100,
"computeResource": 20,
"spec": "opensearch.share.common"
},
"progressPercent": 100,
"updated": 1234567891,
"created": 1590486119
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.