Modifies the properties of an OpenSearch application or sets the online version of an OpenSearch application.
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 Resources
is 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:ModifyAppGroup | update |
|
| none |
Request syntax
PUT /v4/openapi/app-groups/{appGroupIdentity} HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
appGroupIdentity | string | Yes | The name of the application. | my_app_group_name |
body | object | No | The request parameters for the operation. | |
description | string | No | The description of the application. | "test" |
currentVersion | string | No | The online version of the application. | 1223232 |
domain | string | No | The type of the industry. Valid values:
| "ecommerce" |
resourceGroupId | string | No | The ID of the resource group to which the instance belongs. | rg-**** |
dryRun | boolean | No | Specifies whether to verify the application before modification. Valid values: true and false. | true |
Request body
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
chargingWay | Integer | No | 1 | The billing type. Valid values:1: computing resources.2: queries per second (QPS). |
description | String | No | "my_first_app" | The description of the application. |
currentVersion | Integer | No | 12345678 | The ID of the application version. |
Note: The currentVersion parameter takes effect if all fields are included in the request. In this case, this operation preferentially configures the online version of the application.
Response parameters
Examples
Sample success responses
JSON
format
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": {
"created": 1590139524,
"currentVersion": "100302903",
"lockMode": "Unlock",
"updated": 1590978265,
"id": "100302881",
"chargeType": "POSTPAY",
"hasPendingQuotaReviewTask": 0,
"name": "lsh_test_1",
"instanceId": "10030288",
"chargingWay": 1,
"type": "enhanced",
"status": "normal",
"projectId": "1",
"switchedTime": 1590486386,
"commodityCode": "opensearch",
"expireOn": "1",
"domain": "GENERAL",
"description": "1",
"produced": 1,
"quota": {
"spec": "opensearch.share.common",
"docSize": 1,
"computeResource": 20
},
"engineType": "ha3",
"resourceGroupId": "rg-acfmoiyerh6nzly"
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-07 | The response structure of the API has changed | View Change Details |
2023-05-24 | The request parameters of the API has changed | View Change Details |