Creates a version for 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:
- The required resource types are displayed in bold characters.
- 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:CreateApp | create |
|
| none |
Request syntax
POST /v4/openapi/app-groups/{appGroupIdentity}/apps HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| appGroupIdentity | string | Yes | The name of the application | my_app_group_name |
| dryRun | boolean | No | Specifies whether to perform a dry run. This parameter is only used to check whether the data source is valid. Valid values: true and false. | true |
| body | App | No | The request body. |
Request body
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| type | String | Yes | "standard" | The type of the application. Valid values:standard: standard edition.enhanced: advanced edition. |
| schema | Object | Yes | The schema of the application.For more information, see Schema . | |
| fetchFields | Array | Yes | ["id", "name"] | The default display fields. |
| realtimeShared | Boolean | Yes | false | Specifies whether to synchronize real-time data between the online and offline versions of the application. |
| autoSwitch | Boolean | Yes | false | Specifies whether to automatically publish the new version of the application. |
| description | String | No | "demo" | The description of the application. |
| quota | Object | No | The quota information about the application.For more information, see Quota . | |
| dataSources[] | Object | No | The information about each data source.For more information, see DataSource . | |
| firstRanks[] | Object | No | The information about each rough sort expression.For more information, see FirstRank . | |
| secondRanks[] | Object | No | The information about each fine sort expression.For more information, see SecondRank . | |
| queryProcessors[] | Object | No | The information about each query analysis rule.For more information, see QueryProcessor . | |
| summaries[] | Object | No | The settings of search result summaries.For more information, see Summary . |
Response parameters
Examples
Sample success responses
JSONformat
{
"result": {},
"requestId": "ABCDEFG"
}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 |
| 2023-05-30 | The request parameters of the API has changed | View Change Details |