ModifyAppGroup - OpenSearch - Alibaba Cloud Documentation Center

Modifies the properties of an OpenSearch application or sets its online version.

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

update

*AppGroup

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

None

Request syntax

PUT /v4/openapi/app-groups/{appGroupIdentity} 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
body	object	No	The request body.
description	string	No	The description of the application group.	"description"
currentVersion	string	No	The online version of the application.	1223232
domain	string	No	The industry. Valid values: general: general. ecommerce: e-commerce. education: education. esports: gaming. community: content community.	"ecommerce"
resourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-****
dryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true and false.	true

Request body

Parameter	Type	Required	Example	Description
chargingWay	Integer	No	1	The billing model. - 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: This operation prioritizes setting the online version of the application. If you include the `currentVersion` parameter in the request, other parameters are ignored.

Response elements

Element	Type	Description	Example
	object	The response body.	{}
requestId	string	The request ID.	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	The returned data.	{}
created	integer	The UNIX timestamp when the application was created.	159013954
currentVersion	string	The ID of the current online version.	100302903
lockMode	string	The lock mode of the instance. Valid values: Unlock: The instance is not locked. LockByExpiration: The instance is automatically locked after it expires. ManualLock: The instance is manually locked.	Unlock
updated	integer	The UNIX timestamp when the application was last modified.	1590978265
id	string	The application ID.	100302881
chargeType	string	The billing method. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.	POSTPAY
hasPendingQuotaReviewTask	integer	The approval status of the quota. Valid values: 0: normal. 1: being approved.	0
name	string	The name of the application.	lsh_test_1
instanceId	string	The instance ID.	10030288
chargingWay	integer	The billable item. Valid values: 1: computing resources. 2: QPS.	1
type	string	The type of the application. Valid values: standard: a Standard Edition application. advance: an Advanced Edition application of an old version. New applications do not support this type. enhanced: an Enhanced Edition application.	enhanced
status	string	The status of the application. Valid values: producing: The application is being created. review_pending: The application is under review. config_pending: The application requires configuration. normal: The application is running. frozen: The application is frozen.	normal
projectId	string	The name of the A/B test project.	1
switchedTime	integer	The UNIX timestamp when the current online version was published.	1590486386
commodityCode	string	The commodity code.	opensearch
expireOn	string	The expiration time.	1
domain	string	The industry. Valid values: GENERAL: general. ECOMMERCE: e-commerce. IT_CONTENT: IT content.	GENERAL
description	string	The description of the application.	1
produced	integer	Indicates whether the application is created. Valid values: 0: The application is being created. 1: The application is created.	1
quota	object	The quota information of the application.	{}
spec	string	The specifications. Valid values: opensearch.share.junior: Basic opensearch.share.common: Shared General-purpose opensearch.share.compute: Shared Compute-optimized opensearch.share.storage: Shared Storage-optimized opensearch.private.common: Exclusive General-purpose opensearch.private.compute: Exclusive Compute-optimized opensearch.private.storage: Exclusive Storage-optimized	opensearch.share.common
docSize	integer	The storage capacity in GB.	1
computeResource	integer	The computing resources in logical compute units (LCUs).	20
engineType	string	The engine type.	ha3
resourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmoiyerh6nzly

Examples

Success response

JSON format

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 159013954,
    "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.