Queries the version list of an OpenSearch application.
Operation description
- When you create a standard application, a new version of the application is created if the specified application name already exists.
- When you create a version of an existing application, you must specify the autoSwitch and realtimeShared parameters.
- When you create a version of an existing application, the value of the quota parameter is the same as that of the quota parameter in the previous version of the application.
- When you create a version of an existing application, the modification of the value of the quota parameter does not take effect.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| opensearch:ListApp | list | *App acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId} |
| none |
Request syntax
GET /v4/openapi/app-groups/{appGroupIdentity}/apps HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| appGroupIdentity | string | Yes | my_app_group_name | my_app_group_name |
Response parameters
Examples
Sample success responses
JSONformat
{
"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": "Description\n",
"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\n",
"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
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-08-26 | The response structure of the API has changed | View Change Details |